Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for v40 #324

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AudioCuesheetEditor/Pages/EditSplitpoints.razor
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ along with Foobar. If not, see
<TableRow>
<TableHeaderCell>@_localizer["Controls"]</TableHeaderCell>
<TableHeaderCell>@_localizer["Moment"]</TableHeaderCell>
<TableHeaderCell>@_localizer["CD artist"]</TableHeaderCell>
<TableHeaderCell>@_localizer["CD title"]</TableHeaderCell>
</TableRow>
</TableHeader>
<TableBody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
"Add new split point": "Neuen Aufteilungspunkt hinzufügen",
"Controls": "Steuerung",
"Moment": "Zeitpunkt",
"Delete split tooltip": "Löscht diesen Aufteilungspunkt"
"Delete split tooltip": "Löscht diesen Aufteilungspunkt",
"CD artist": "CD Künstler",
"CD title": "CD Titel"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
"Add new split point": "Add new split point",
"Controls": "Controls",
"Moment": "Moment",
"Delete split tooltip": "Deletes this split point"
"Delete split tooltip": "Deletes this split point",
"CD artist": "CD artist",
"CD title": "CD title"
}
}
2 changes: 1 addition & 1 deletion AudioCuesheetEditor/Resources/Localization/Help/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"Scroll to top": "Nach oben springen",
"What is AudioCuesheetEditor helptext": "<strong>AudioCuesheet</strong> ist eine Web Applikation für das Schreiben von Audio Cuesheet Dateien. Audio Cuesheet Dateien sind kleine Textdateien, die Informationen über die Audiodatei bereit stellen, wie etwa z.B. Künstler, Titel, aber auch Anfang und Ende. AudioCuesheetEditor ist eine Applikation die Ihnen dabei helfen soll, gültige und korrekte Cuesheets zu erhalten. Sie können außerdem auch fertige Dateien importieren, um ihre Arbeit zu minimieren. Außerdem können Sie die gesammelten Daten auch in verschiedene, individuelle Exportformate überführen.",
"Features helptext": "<ul><li>Validierung aller Daten</li><li>Verschiedene Importmöglichkeiten (Text, Cuesheet, Projektdateien)</li><li>Verschiedene Export Möglichkeiten (XML/CSV,Text, etc)</li><li>Audio Wiedergabe</li><li>Aufnahmemodus</li><li>Rückgängig/Wiederherstellen von Änderungen</li><li>Massenänderungen</li></ul>",
"Validation helptext": "AudioCuesheetEditor arbeitet mit einem validiertem Datenmodell und prüft jede Eingabe. Es gibt folgende Validierungstypen:<dl><dt>Warnung</dt><dd>Warnungen sind Meldungen, die eventuell für Sie wichtig sind, jedoch keine Funktionen blockieren.</dd><dt>Fehler</dt><dd>Fehler sind Meldungen, die unbedingt behoben werden müssen (wie etwa Tracks mit ungültigen Zeiten).</dd></dl>Validierungsmeldungen werden auf der rechten Seite angezeigt und verweisen auf die Datenfelder.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/Validation1_de.png\"/></div>Jede Validierungsmeldung kann angeklickt werden, um zu dem entsprechenden Feld zu springen und das Feld zu korrigieren.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/Validation2_de.png\"/></div>",
"Validation helptext": "AudioCuesheetEditor arbeitet mit einem validiertem Datenmodell und prüft jede Eingabe. In den meisten Fällen werden Validierungsfehler neben den Eingabefeldern angezeigt, um Ihnen eine klare Information zu ermöglichen.",
"Track linking helptext": "Es ist möglich einen Track mit dem vorherigen Track zu koppeln. Dies stellt sicher, dass Änderungen an Beginn, Ende und Position automatisch in den anschließenden Track übertragen werden.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/TrackLinking1_de.png\"/></div>Wenn ein Track mit dem vorherigen Track gekoppelt ist, können Sie beispielsweise das Ende verändern und ihre Änderung wird automatisch in den nachfolgenden Track bei Beginn eingetragen. Wenn Sie die Kopplung aufheben möchten, klicken sie einfach auf den orangfarbenenen \"Abkoppeln\" Button. Wenn Sie anschließend die Kopplung wiederherstellen möchten, klicken Sie einfach auf den grünen \"Koppeln\" Button.",
"Create cuesheet helptext": "Cuesheets können sehr einfach und schnell mit der vorhandenen Eingabemaske erstellt werden. Dafür füllen Sie einfach CD Künstler und CD Titel in den vorhandenen Feldern aus. Wählen Sie bitte außerdem eine Audio Datei aus indem Sie eine Datei aus ihrem Datei System auf die Ablagefläche ziehen oder die Datei manuell mit dem Auswahldialog auswählen.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/CreateCuesheet1_de.png\"/></div>Anschließend können Sie einen Track hinzufügen indem Sie den \"Neuen Track hinzufügen\" Button klicken. Ein neuer Track wird angezeigt und sie können seine Eigenschaften wie Künstler, Titel, Beginn, Ende oder Länge bearbeiten. Bitte beachten Sie, dass der Beginn jedes Tracks von seinem vorherigen Ende automatisch berechnet wird. Daher ist es ratsam, einen weiteren Track erst dann hinzuzufügen, wenn alle Daten ausgefüllt sind.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/CreateCuesheet2_de.png\"/></div>Wenn Sie alle Tracks hinzugefügt haben, die in der Audio Datei vorhanden sind und alle notwendigen Felder ausgefüllt haben, können Sie das Cuesheet herunterladen indem Sie auf \"Export\" klicken und dann auf \"Cuesheet herunterladen\". Außerdem können Sie die Daten auch in anderen Formaten herunterladen, iden Sie auf \"Export\" und dann auf \"Export Profile anzeigen\" klicken.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/CreateCuesheet3_de.png\"/></div>",
"Import of textfiles helptext": "Sie können Textdatein importieren und den Inhalt zeilenweise mit regulären Ausdrücken auswerten. Eine einfache Beispiel Textdatei kann <a href=\"samples/Sample_Inputfile.txt\" download>hier</a> gefunden werden.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/SampleInputfile1.png\"/></div>Jede Zeile repräsentiert einen Track, die erste Zeile jedoch Cuesheet Details und jedes Detail kann aus einer Zeile ausgelesen werden. Die erste Information ist der Track Künstler gefolgt von \" - \" und dem Track Titel. Dann kommen ein paar Tabs und Informationen über das Track Ende. So benötigen wir in diesem Beispiel den Regulären Ausdruck \"(?'Track.Artist'[a-zA-Z0-9_ .();äöü&:,]{1,}) - (?'Track.Title'[a-zA-Z0-9_ .();äöü]{1,})\t{1,}(?'Track.End'.{1,})\" für Tracks und \"(?'Cuesheet.Artist'\\A.*) - (?'Cuesheet.Title'\\w{1,})\t{1,}(?'Cuesheet.Audiofile'.{1,})\" für Cuesheet Details. Jedes Feld kann mit \"Entität.Feldname\" erreicht werden. Sie können den Textimport einfach starten, indem Sie in den Anzeigemodus \"Import Assistent\" wechseln und dort eine Datei aus dem Dateisystem auf die Ablagefläche zieht oder sie manuell über den Dateiauswahldialog auswählt.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile1_de.png\"/></div>Der Assistent wechselt nach der Analyse der Daten in die Detailansicht und sie können den Textimport verändern und so anpassen, dass er zu ihrer Textdatei passt und alle Informationen erfasst werden können.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile2_de.png\"/></div>Änderungen am Import Textschema verändern die Vorschau und spiegeln das Ergebnis wieder.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile3_de.png\"/></div>Sie können alle gültigen Platzhalter eines Tracks erreichen, indem Sie \"Platzhalter auswählen\" anklicken und dann den Platzhalter den Sie benötigen.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile4_de.png\"/></div>Wenn Sie ein ungültiges Import Textschema angeben, wird ihnen ein Validierungsfehler angezeigt.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile8_de.png\"/></div>Geben Sie ein Schema an, dass nicht zur Textdatei passt, wird ihnen ein Fehler angezeigt.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile5_de.png\"/></div>Fehler blockieren immer den Import und müssen korrigiert werden.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile6_de.png\"/></div>Wenn Sie nur Tracks importieren möchten, lassen Sie das Schema für Cuesheet leer und geben Sie eine Textdatei an, die nur Trackdetails enthält. Ein Beispiel kann <a href=\"samples/Sample_Inputfile2.txt\" download>hier</a> gefunden werden.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/SampleInputfile2.png\"/></div>Der Import kann nach dem gleichem Muster stattfinden.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile9_de.png\"/></div>",
Expand Down
2 changes: 1 addition & 1 deletion AudioCuesheetEditor/Resources/Localization/Help/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"Scroll to top": "Scroll to top",
"What is AudioCuesheetEditor helptext": "<strong>AudioCuesheet</strong> is a web application for writting audio cuesheet files. Audio cuesheet files are little text files which provide information about the provided audio file like for example artist, name, but also start and end. AudioCuesheetEditor is an application that helps you writting valid cuesheet files by checking and validation input data. You can also import data from files to minimize your work. Exporting data to individual formats is also possible.",
"Features helptext": "<ul><li>Validation for all data</li><li>Several import options (Text, Cuesheet, Projectfiles)</li><li>Several export profiles (XML/CSV,Text, etc)</li><li>Audio playback</li><li>Live record mode</li><li>Undo/Redo changes</li><li>Bulk edit</li></ul>",
"Validation helptext": "AudioCuesheetEditor works with a validation model and evaluates every input. Possible types of validation are:<dl><dt>Warning</dt><dd>Warnings are validationmessages, that might be important for you, but don't block functions.</dd><dt>Error</dt><dd>Errors are validationmessages that need to be corrected (like tracks with invalid times).</dd></dl>Validation messages are displayed on the right with link to the corresponding field.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/Validation1_en.png\"/></div>Each message can be clicked to jump to the corresponding field and correct the field.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/Validation2_en.png\"/></div>",
"Validation helptext": "AudioCuesheetEditor works with a validation model and evaluates every input. In most cases the validation messages are presented next to the input, giving you a clear instruction what is missing.",
"Track linking helptext": "It is possible to link a track with the previous track. This makes shure, that changes to Begin,End and Position are automatically transfered to the next following track. <img style=\"width:100%\" src=\"images/TrackLinking1.png\"/> If a track is linked to the previous track, you can change for example the End and the Begin of the following linked track is automatically replaced with the End you entered. If you wish to disable linking, just click on the orange \"Unlink\" Button. If you afterwards want to link the tracks again, just hit the green \"Link\" Button.",
"Create cuesheet helptext": "Creation of Cuesheet can be done very easily and fast using the standard GUI without import of files. To do so, enter the CD artist and CD title in the appropriate fields. Also select an audio file on your computer by draging the file from file explorer to the drop zone or manually selecting the file via file chooser.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/CreateCuesheet1_en.png\"/></div>Afterwards you need to insert a track by clickin the \"Add new track\" button. A new track is added and you can edit its properties like Artist, Title or Begin, End or Length. Please keep in mind, that every tracks begin gets calculated from the end of the previous track. Therefore its adviced to edit one track and fill its data before adding a new one.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/CreateCuesheet2_en.png\"/></div>When you have added all tracks from the audio file and filled all necessary fields, you can export the cuesheet in the top by clickin \"Export\" and then \"Download cuesheet\". You can also export the result in other formats like XML, CSV or text by clicking \"Export\" and then \"Display Export Profiles\".<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block mx-auto d-block\" src=\"images/CreateCuesheet3_en.png\"/></div>",
"Import of textfiles helptext": "You can import plain text files and analyse the content of each line by simple regular expressions. A simple sample textfile can be found <a href=\"samples/Sample_Inputfile.txt\" download>here</a>.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/SampleInputfile1.png\"/></div>Each line represents a track, but the first line represents cuesheet details and every detail can be extracted from the line. First information that can be found is the track artist, followed by \" - \" and then track title. Afterwards some tabs come and you can see information about the track end time. So in this example we can work with the regular expression for tracks \"%?'Track.Artist'[a-zA-Z0-9_ .();äöü&:,]{1,}) - (?'Track.Title'[a-zA-Z0-9_ .();äöü]{1,})\t{1,}(?'Track.End'.{1,})\" and with \"(?'Cuesheet.Artist'\\A.*) - (?'Cuesheet.Title'\\w{1,})\t{1,}(?'Cuesheet.Audiofile'.{1,})\" for cuesheet data. Each field can be accessed via \"Entity.Fieldname\".You can start importing a textfile by selecting viewmode \"Import asssistant\" and drag the file from filesystem to the dropzone or by manually selecting it from file chooser dialog.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile2_en.png\"/></div>Changing the import textscheme will result in changes of the import result and the data to import will be shown to you.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile3_en.png\"/></div>You can select the valid fields by pressing the button \"Select placeholder\" and afterwards selecting the placeholder you want to add.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile4_en.png\"/></div>If you enter an invalid text import scheme, a validation error will be displayed.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile8_en.png\"/></div>If the import scheme doesn't match the text file, an error will be displayed to you.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile5_en.png\"/></div>Errors will always block import of text, so you have to correct them at first before import can take place.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile6_en.png\"/></div>If you want to import a tracks only textfile, just leave the cuesheet scheme empty and add a textfile with track properties only. A sample can be found <a href=\"samples/Sample_Inputfile2.txt\" download>here</a>.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/SampleInputfile2.png\"/></div>Import can be done the same way.<div class=\"container-fluid\"><img class=\"img-fluid img-thumbnail mx-auto d-block\" src=\"images/ImportTextfile9_en.png\"/></div>",
Expand Down
Binary file modified AudioCuesheetEditor/wwwroot/images/CreateCuesheet1_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/CreateCuesheet1_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/CreateCuesheet2_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/CreateCuesheet2_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/ImportCuesheet2_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/ImportCuesheet2_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/ImportCuesheet3_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/ImportCuesheet3_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/RecordMode1_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/RecordMode1_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/RecordMode5_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/RecordMode5_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/TrackLinking1_de.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified AudioCuesheetEditor/wwwroot/images/TrackLinking1_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading