Skip to content

Commit b12cf9e

Browse files
KSemenenkoKSemenenko
committed
Add in-app help documentation (#45)
1 parent ab5611b commit b12cf9e

16 files changed

Lines changed: 456 additions & 0 deletions

‎src/PrompterOne.Shared/Contracts/UiTestIds.Settings.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ public static class Settings
3232
public const string FeedbackOpen = "settings-feedback-open";
3333
public const string FeedbackPanel = "settings-feedback-panel";
3434
public const string FilesExportsCard = "settings-files-exports-card";
35+
public const string HelpAppFlowCard = "settings-help-app-flow-card";
36+
public const string HelpLocalFilesCard = "settings-help-local-files-card";
37+
public const string HelpModesCard = "settings-help-modes-card";
38+
public const string HelpPanel = "settings-help-panel";
39+
public const string HelpTpsBasicsCard = "settings-help-tps-basics-card";
3540
public const string LanguagePanel = "settings-language-panel";
3641
public const string LanguagePreferencesCard = "settings-language-preferences-card";
3742
public const string LanguageSelect = "settings-language-select";
@@ -72,6 +77,7 @@ public static class Settings
7277
public const string NavCloud = "settings-nav-cloud";
7378
public const string NavFeedback = "settings-nav-feedback";
7479
public const string NavFiles = "settings-nav-files";
80+
public const string NavHelp = "settings-nav-help";
7581
public const string NavMics = "settings-nav-mics";
7682
public const string NavRecording = "settings-nav-recording";
7783
public const string NavShortcuts = "settings-nav-shortcuts";

‎src/PrompterOne.Shared/Localization/SharedResource.de.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,48 @@
312312
<data name="SettingsNavLanguage" xml:space="preserve">
313313
<value>Sprache</value>
314314
</data>
315+
<data name="SettingsNavHelp" xml:space="preserve">
316+
<value>Hilfe</value>
317+
</data>
318+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
319+
<value>Lernen Sie den PrompterOne-Ablauf, TPS-Grundlagen, Probenmodi und das Verhalten lokaler Dateien kennen, ohne die App zu verlassen.</value>
320+
</data>
321+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
322+
<value>PrompterOne-Ablauf</value>
323+
</data>
324+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
325+
<value>Von der Skriptbibliothek bis zur Live-Ausgabe</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
328+
<value>Beginnen Sie in Library, schreiben oder importieren Sie ein Skript in Editor, wechseln Sie zu Cards, wenn Sie visuell ohne TPS-Syntax bearbeiten möchten, proben Sie in Learn, lesen Sie in Teleprompter und verwenden Sie Go Live, wenn Sie aufnehmen oder streamen möchten.</value>
329+
</data>
330+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
331+
<value>TPS-Standardgrundlagen</value>
332+
</data>
333+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
334+
<value>Einfacher Text mit leichten Performance-Hinweisen</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
337+
<value>TPS hält ein Skript lesbar und ergänzt Struktur sowie Vortragsabsicht. Verwenden Sie ##-Überschriften für Segmente, ###-Überschriften für Blöcke, WPM-Werte für das Tempo, Emotionen für den Ton und Klammerhinweise wie Pausen, Geschwindigkeit, Aussprache, Betonung und Vortragsnotizen.</value>
338+
</data>
339+
<data name="SettingsHelpModesTitle" xml:space="preserve">
340+
<value>Schreib- und Probenmodi</value>
341+
</data>
342+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
343+
<value>Wählen Sie die Oberfläche für die jeweilige Aufgabe</value>
344+
</data>
345+
<data name="SettingsHelpModesCopy" xml:space="preserve">
346+
<value>Source dient der direkten TPS-Bearbeitung, Cards der Bearbeitung gerenderter Blöcke, Graph zeigt die Skriptstruktur, Learn nutzt RSVP für Wort-für-Wort-Übung, Teleprompter ist der Live-Reader, und Go Live kombiniert Lesen mit Kamera-, Aufnahme- und Streaming-Steuerung.</value>
347+
</data>
348+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
349+
<value>Lokale Dateien und Verlauf</value>
350+
</data>
351+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
352+
<value>Zuerst Autosave, Import und Export bei Bedarf</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
355+
<value>PrompterOne speichert Skripte und Einstellungen lokal im Browser. Verwenden Sie Import und Export für Dateien auf der Festplatte, verlassen Sie sich beim Schreiben auf lokales Autosave und nutzen Sie den lokalen Verlauf, um frühere Versionen des aktuellen Skripts wiederherzustellen.</value>
356+
</data>
315357
<data name="SettingsNavFeedback" xml:space="preserve">
316358
<value>Feedback</value>
317359
</data>

‎src/PrompterOne.Shared/Localization/SharedResource.es.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,48 @@
312312
<data name="SettingsNavLanguage" xml:space="preserve">
313313
<value>Idioma</value>
314314
</data>
315+
<data name="SettingsNavHelp" xml:space="preserve">
316+
<value>Ayuda</value>
317+
</data>
318+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
319+
<value>Aprende el flujo de PrompterOne, los conceptos básicos de TPS, los modos de ensayo y el comportamiento de los archivos locales sin salir de la app.</value>
320+
</data>
321+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
322+
<value>Flujo de PrompterOne</value>
323+
</data>
324+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
325+
<value>De la biblioteca de guiones a la entrega en vivo</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
328+
<value>Empieza en Library, escribe o importa un guion en Editor, cambia a Cards cuando quieras edición visual sin sintaxis TPS, ensaya en Learn, lee en Teleprompter y usa Go Live cuando estés listo para grabar o transmitir.</value>
329+
</data>
330+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
331+
<value>Conceptos básicos del estándar TPS</value>
332+
</data>
333+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
334+
<value>Texto plano con indicaciones ligeras de interpretación</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
337+
<value>TPS mantiene el guion legible y añade estructura e intención de entrega. Usa encabezados ## para segmentos, encabezados ### para bloques, valores WPM para el ritmo, emociones para el tono e indicaciones entre corchetes como pausas, velocidad, pronunciación, énfasis y notas de entrega.</value>
338+
</data>
339+
<data name="SettingsHelpModesTitle" xml:space="preserve">
340+
<value>Modos de escritura y ensayo</value>
341+
</data>
342+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
343+
<value>Elige la superficie que corresponde al trabajo</value>
344+
</data>
345+
<data name="SettingsHelpModesCopy" xml:space="preserve">
346+
<value>Source sirve para editar TPS sin procesar, Cards para editar bloques renderizados, Graph muestra la estructura del guion, Learn usa RSVP para practicar palabra por palabra, Teleprompter es el lector en vivo y Go Live combina lectura con cámara, grabación y controles de streaming.</value>
347+
</data>
348+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
349+
<value>Archivos locales e historial</value>
350+
</data>
351+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
352+
<value>Primero autoguardado, importa y exporta cuando haga falta</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
355+
<value>PrompterOne guarda guiones y preferencias localmente en el navegador. Usa Import y Export para archivos del disco, confía en el autoguardado local mientras escribes y usa el historial local para recuperar revisiones anteriores del guion actual.</value>
356+
</data>
315357
<data name="SettingsNavFeedback" xml:space="preserve">
316358
<value>Comentarios</value>
317359
</data>

‎src/PrompterOne.Shared/Localization/SharedResource.fr.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,48 @@
312312
<data name="SettingsNavLanguage" xml:space="preserve">
313313
<value>Langue</value>
314314
</data>
315+
<data name="SettingsNavHelp" xml:space="preserve">
316+
<value>Aide</value>
317+
</data>
318+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
319+
<value>Découvrez le flux PrompterOne, les bases de TPS, les modes de répétition et le comportement des fichiers locaux sans quitter l’app.</value>
320+
</data>
321+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
322+
<value>Flux PrompterOne</value>
323+
</data>
324+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
325+
<value>De la bibliothèque de scripts à la lecture en direct</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
328+
<value>Commencez dans Library, écrivez ou importez un script dans Editor, passez à Cards lorsque vous voulez une édition visuelle sans syntaxe TPS, répétez dans Learn, lisez dans Teleprompter et utilisez Go Live quand vous êtes prêt à enregistrer ou diffuser.</value>
329+
</data>
330+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
331+
<value>Bases du standard TPS</value>
332+
</data>
333+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
334+
<value>Texte simple avec des indications légères de performance</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
337+
<value>TPS garde un script lisible tout en ajoutant structure et intention de lecture. Utilisez les titres ## pour les segments, les titres ### pour les blocs, les valeurs WPM pour le rythme, les émotions pour le ton et les indications entre crochets comme les pauses, la vitesse, la prononciation, l’emphase et les notes de delivery.</value>
338+
</data>
339+
<data name="SettingsHelpModesTitle" xml:space="preserve">
340+
<value>Modes d’écriture et de répétition</value>
341+
</data>
342+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
343+
<value>Choisissez la surface adaptée à la tâche</value>
344+
</data>
345+
<data name="SettingsHelpModesCopy" xml:space="preserve">
346+
<value>Source sert à modifier le TPS brut, Cards à modifier les blocs rendus, Graph affiche la structure du script, Learn utilise RSVP pour s’entraîner mot par mot, Teleprompter est le lecteur en direct, et Go Live combine lecture, caméra, enregistrement et contrôles de streaming.</value>
347+
</data>
348+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
349+
<value>Fichiers locaux et historique</value>
350+
</data>
351+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
352+
<value>Autosave d’abord, import et export si nécessaire</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
355+
<value>PrompterOne stocke les scripts et préférences localement dans le navigateur. Utilisez Import et Export pour les fichiers sur disque, appuyez-vous sur l’autosave local pendant l’écriture et utilisez l’historique local pour restaurer d’anciennes révisions du script actuel.</value>
356+
</data>
315357
<data name="SettingsNavFeedback" xml:space="preserve">
316358
<value>Retour</value>
317359
</data>

‎src/PrompterOne.Shared/Localization/SharedResource.it.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,48 @@
312312
<data name="SettingsNavLanguage" xml:space="preserve">
313313
<value>Lingua</value>
314314
</data>
315+
<data name="SettingsNavHelp" xml:space="preserve">
316+
<value>Aiuto</value>
317+
</data>
318+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
319+
<value>Scopri il flusso di PrompterOne, le basi di TPS, le modalità di prova e il comportamento dei file locali senza uscire dall’app.</value>
320+
</data>
321+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
322+
<value>Flusso di PrompterOne</value>
323+
</data>
324+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
325+
<value>Dalla libreria degli script alla lettura live</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
328+
<value>Inizia in Library, scrivi o importa uno script in Editor, passa a Cards quando vuoi modificare visivamente senza sintassi TPS, fai pratica in Learn, leggi in Teleprompter e usa Go Live quando sei pronto per registrare o trasmettere.</value>
329+
</data>
330+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
331+
<value>Basi dello standard TPS</value>
332+
</data>
333+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
334+
<value>Testo semplice con leggere indicazioni di performance</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
337+
<value>TPS mantiene lo script leggibile aggiungendo struttura e intenzione di lettura. Usa intestazioni ## per i segmenti, intestazioni ### per i blocchi, valori WPM per il ritmo, emozioni per il tono e indicazioni tra parentesi come pause, velocità, pronuncia, enfasi e note di delivery.</value>
338+
</data>
339+
<data name="SettingsHelpModesTitle" xml:space="preserve">
340+
<value>Modalità di scrittura e prova</value>
341+
</data>
342+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
343+
<value>Scegli la superficie adatta al lavoro</value>
344+
</data>
345+
<data name="SettingsHelpModesCopy" xml:space="preserve">
346+
<value>Source serve per modificare il TPS grezzo, Cards per modificare blocchi renderizzati, Graph mostra la struttura dello script, Learn usa RSVP per esercitarsi parola per parola, Teleprompter è il reader live e Go Live combina lettura con controlli per camera, registrazione e streaming.</value>
347+
</data>
348+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
349+
<value>File locali e cronologia</value>
350+
</data>
351+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
352+
<value>Prima autosave, import ed export quando serve</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
355+
<value>PrompterOne salva script e preferenze localmente nel browser. Usa Import ed Export per i file su disco, affidati all’autosave locale mentre scrivi e usa la cronologia locale per recuperare revisioni precedenti dello script corrente.</value>
356+
</data>
315357
<data name="SettingsNavFeedback" xml:space="preserve">
316358
<value>Feedback</value>
317359
</data>

‎src/PrompterOne.Shared/Localization/SharedResource.pt.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,48 @@
312312
<data name="SettingsNavLanguage" xml:space="preserve">
313313
<value>Idioma</value>
314314
</data>
315+
<data name="SettingsNavHelp" xml:space="preserve">
316+
<value>Ajuda</value>
317+
</data>
318+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
319+
<value>Aprenda o fluxo do PrompterOne, os conceitos básicos de TPS, os modos de ensaio e o comportamento de arquivos locais sem sair do app.</value>
320+
</data>
321+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
322+
<value>Fluxo do PrompterOne</value>
323+
</data>
324+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
325+
<value>Da biblioteca de roteiros à entrega ao vivo</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
328+
<value>Comece em Library, escreva ou importe um roteiro no Editor, mude para Cards quando quiser edição visual sem sintaxe TPS, ensaie em Learn, leia no Teleprompter e use Go Live quando estiver pronto para gravar ou transmitir.</value>
329+
</data>
330+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
331+
<value>Conceitos básicos do padrão TPS</value>
332+
</data>
333+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
334+
<value>Texto simples com indicações leves de performance</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
337+
<value>TPS mantém o roteiro legível enquanto adiciona estrutura e intenção de entrega. Use títulos ## para segmentos, títulos ### para blocos, valores WPM para ritmo, emoções para tom e indicações entre colchetes como pausas, velocidade, pronúncia, ênfase e notas de entrega.</value>
338+
</data>
339+
<data name="SettingsHelpModesTitle" xml:space="preserve">
340+
<value>Modos de escrita e ensaio</value>
341+
</data>
342+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
343+
<value>Escolha a superfície adequada para o trabalho</value>
344+
</data>
345+
<data name="SettingsHelpModesCopy" xml:space="preserve">
346+
<value>Source é para editar TPS bruto, Cards para editar blocos renderizados, Graph mostra a estrutura do roteiro, Learn usa RSVP para praticar palavra por palavra, Teleprompter é o leitor ao vivo e Go Live combina leitura com câmera, gravação e controles de streaming.</value>
347+
</data>
348+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
349+
<value>Arquivos locais e histórico</value>
350+
</data>
351+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
352+
<value>Autosave primeiro, import e export quando precisar</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
355+
<value>PrompterOne armazena roteiros e preferências localmente no navegador. Use Import e Export para arquivos no disco, conte com o autosave local enquanto escreve e use o histórico local para recuperar revisões anteriores do roteiro atual.</value>
356+
</data>
315357
<data name="SettingsNavFeedback" xml:space="preserve">
316358
<value>Feedback</value>
317359
</data>

‎src/PrompterOne.Shared/Localization/SharedResource.resx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,48 @@
318318
<data name="SettingsNavLanguage" xml:space="preserve">
319319
<value>Language</value>
320320
</data>
321+
<data name="SettingsNavHelp" xml:space="preserve">
322+
<value>Help</value>
323+
</data>
324+
<data name="SettingsHelpSectionDescription" xml:space="preserve">
325+
<value>Learn the PrompterOne workflow, TPS basics, rehearsal modes, and local file behavior without leaving the app.</value>
326+
</data>
327+
<data name="SettingsHelpAppFlowTitle" xml:space="preserve">
328+
<value>PrompterOne workflow</value>
329+
</data>
330+
<data name="SettingsHelpAppFlowSubtitle" xml:space="preserve">
331+
<value>From script library to live delivery</value>
332+
</data>
333+
<data name="SettingsHelpAppFlowCopy" xml:space="preserve">
334+
<value>Start in Library, write or import a script in Editor, switch to Cards when you want visual editing without TPS syntax, rehearse in Learn, read in Teleprompter, and use Go Live when you are ready to record or stream.</value>
335+
</data>
336+
<data name="SettingsHelpTpsBasicsTitle" xml:space="preserve">
337+
<value>TPS standard basics</value>
338+
</data>
339+
<data name="SettingsHelpTpsBasicsSubtitle" xml:space="preserve">
340+
<value>Plain text with lightweight performance cues</value>
341+
</data>
342+
<data name="SettingsHelpTpsBasicsCopy" xml:space="preserve">
343+
<value>TPS keeps a script readable while adding structure and delivery intent. Use ## headings for segments, ### headings for blocks, WPM values for pace, emotions for tone, and bracket cues such as pauses, speed, pronunciation, emphasis, and delivery notes.</value>
344+
</data>
345+
<data name="SettingsHelpModesTitle" xml:space="preserve">
346+
<value>Writing and rehearsal modes</value>
347+
</data>
348+
<data name="SettingsHelpModesSubtitle" xml:space="preserve">
349+
<value>Choose the surface that matches the job</value>
350+
</data>
351+
<data name="SettingsHelpModesCopy" xml:space="preserve">
352+
<value>Source is for raw TPS editing, Cards is for rendered block editing, Graph shows the script structure, Learn uses RSVP for word-by-word practice, Teleprompter is the live reader, and Go Live combines reading with camera, recording, and streaming controls.</value>
353+
</data>
354+
<data name="SettingsHelpLocalFilesTitle" xml:space="preserve">
355+
<value>Local files and history</value>
356+
</data>
357+
<data name="SettingsHelpLocalFilesSubtitle" xml:space="preserve">
358+
<value>Autosave first, import and export when needed</value>
359+
</data>
360+
<data name="SettingsHelpLocalFilesCopy" xml:space="preserve">
361+
<value>PrompterOne stores scripts and preferences locally in the browser. Use Import and Export for files on disk, rely on local autosave while writing, and use local history to recover earlier revisions of the current script.</value>
362+
</data>
321363
<data name="SettingsNavShortcuts" xml:space="preserve">
322364
<value>Shortcuts</value>
323365
</data>

0 commit comments

Comments
 (0)