diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/docs/De/control_center.rst b/docs/source/docs/De/control_center.rst new file mode 100644 index 0000000..b07733b --- /dev/null +++ b/docs/source/docs/De/control_center.rst @@ -0,0 +1,30 @@ +Kontrollzentrum-Seite +--------------------- + +.. image:: ../image/control_center/control_center.png + +Eine Seite, die jedes Overlay erreicht, auch die von den anderen +Registerkarten geöffneten. + +Schließen + +* Alle Videos / Bilder / GIFs / Webseiten / Töne / Texte schließen - nur diese Art. +* Alles schließen - jedes Overlay auf dem Bildschirm, gleich von welcher Seite. +* Log löschen - den Meldungsbereich rechts leeren. + +Alles auf einmal + +* Alle ausblenden / anzeigen - kurz wegräumen und zurückholen. +* Alle stummschalten - alles Tönende verstummen lassen. +* Overlays sperren / entsperren - entsperrt lassen sie sich mit der Maus an + ihren Platz ziehen und merken sich, wo sie abgelegt wurden; gesperrt lassen + sie Klicks durch. +* Chroma Key - den Hintergrund einfarbig einfärben, zum Keyen in OBS und + Ähnlichem. +* Overlay-Positionen zurücksetzen - alles an den Ausgangsort. +* Energiesparmodus - Bildrate und Auflösung senken, wenn der Akku zählt. +* Qualität - Hoch, Ausgewogen oder Sparsam, dieselbe Idee feiner abgestuft. +* Vor Aufnahme verbergen - die Overlays bleiben auf Ihrem Bildschirm, fehlen + aber in dem, was eine Bildschirmfreigabe aufzeichnet. Nur unter Windows. Eine + Abdeckung von der Fokus-Seite bleibt sichtbar, denn etwas zu verdecken ist + genau ihr Zweck. diff --git a/docs/source/docs/De/de_index.rst b/docs/source/docs/De/de_index.rst new file mode 100644 index 0000000..f159d08 --- /dev/null +++ b/docs/source/docs/De/de_index.rst @@ -0,0 +1,28 @@ +FrontEngine Deutsche Dokumentation +---------------------------------- + +.. toctree:: + :maxdepth: 4 + + ui.rst + video.rst + image.rst + web.rst + gif_and_webp.rst + sound.rst + text.rst + scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst + control_center.rst + menus.rst + +---- + +Die Dokumentation für Mitwirkende - UI erweitern, Release-Prozess - gibt es bisher nur auf Englisch, siehe English Documentation. diff --git a/docs/source/docs/De/focus.rst b/docs/source/docs/De/focus.rst new file mode 100644 index 0000000..f4393db --- /dev/null +++ b/docs/source/docs/De/focus.rst @@ -0,0 +1,13 @@ +Fokus-Seite +----------- + +* Hintergrundfenster abdunkeln - alles außer dem benutzten Fenster verdunkeln, + mit einstellbarer Stärke. +* Störendes abdecken - einen Teil des Bildschirms verbergen: den unteren + Streifen mit der Taskleiste, die Ecke unten rechts, den oberen Streifen, eine + der beiden Seitenkanten oder den ganzen Bildschirm. +* Zielbildschirm - welcher Bildschirm, oder jedes Mal nachfragen. + +Beide lassen Klicks durch: Was sie abdecken, funktioniert weiter, es lenkt nur +nicht mehr ab. Eine Abdeckung bleibt außerdem in einer Bildschirmfreigabe +sichtbar, denn etwas zu verdecken ist genau ihr Zweck. diff --git a/docs/source/docs/De/gif_and_webp.rst b/docs/source/docs/De/gif_and_webp.rst new file mode 100644 index 0000000..90f5a37 --- /dev/null +++ b/docs/source/docs/De/gif_and_webp.rst @@ -0,0 +1,14 @@ +GIF- und WEBP-Seite +------------------- + +.. image:: ../image/gif_and_webp/gif_and_webp.png + +* GIF- oder WEBP-Datei wählen - die Animation. +* GIF oder WEBP abspielen - anzeigen. +* Deckkraft - wie durchsichtig sie ist. +* Geschwindigkeit - wie schnell sie läuft. +* Vollbild - auf den ganzen Bildschirm strecken. +* Auf allen Bildschirmen zeigen - eine Kopie je Monitor. +* Unter allen Fenstern zeigen - unter die anderen Fenster legen. +* Zielbildschirm - welcher Bildschirm, oder jedes Mal nachfragen. +* Zuletzt verwendet - vorher gezeigte Animationen. diff --git a/docs/source/docs/De/image.rst b/docs/source/docs/De/image.rst new file mode 100644 index 0000000..a9886f1 --- /dev/null +++ b/docs/source/docs/De/image.rst @@ -0,0 +1,20 @@ +Bild-Seite +---------- + +.. image:: ../image/image_page/image_page.png + +* Bild wählen - das anzuzeigende Bild. +* Bild anzeigen. +* Deckkraft - wie durchsichtig das Bild ist. +* Vollbild - auf den ganzen Bildschirm strecken. +* Auf allen Bildschirmen zeigen - eine Kopie je Monitor. +* Unter allen Fenstern zeigen - unter die anderen Fenster legen. +* Diashow - alle Bilder eines Ordners nacheinander zeigen. + + * Ordner wählen - wo die Bilder liegen. + * Intervall - Sekunden je Bild. + * Zufällig - gemischte Reihenfolge. + * Unterordner einbeziehen. + +* Zielbildschirm - welcher Bildschirm, oder jedes Mal nachfragen. +* Zuletzt verwendet - vorher gezeigte Bilder. diff --git a/docs/source/docs/De/menus.rst b/docs/source/docs/De/menus.rst new file mode 100644 index 0000000..0467f72 --- /dev/null +++ b/docs/source/docs/De/menus.rst @@ -0,0 +1,46 @@ +Voreinstellungen und Einstellungen +---------------------------------- + +Menü „Voreinstellungen“ + +* Voreinstellung speichern… - alle Seiteneinstellungen unter einem Namen. +* Voreinstellung laden… - zurückholen. +* Voreinstellung löschen… +* Exportieren… / Importieren… - als json-Datei zwischen Rechnern bewegen. +* Paket exportieren (+Medien) / importieren (+Medien) - dasselbe, aber mit den + Bildern, Videos und Tönen darin, als zip. +* Als Start-Voreinstellung festlegen… - beim Start von FrontEngine anwenden. +* Workshop-Inhalte importieren… - auf Steam abonnierte Voreinstellungen und + Haustier-Pakete installieren. + +Menü „Einstellungen“ + +* Tastenkürzel… - global für alle ausblenden, anzeigen, schließen, + stummschalten, Deckkraft hoch und runter, nächste Dashboard-Seite und sperren. +* Tag-/Nacht-Design nach Zeitplan - tagsüber hell, nachts dunkel. +* Mit dem System starten - FrontEngine bei der Anmeldung starten. +* Letzte Sitzung wiederherstellen - wieder öffnen, was zuletzt zu sehen war. +* Plugins laden (fortgeschritten) - Plugins sind Python und laufen mit + denselben Rechten wie FrontEngine; installieren Sie nur, was Sie kennen. +* Intelligente Pause… - Overlays wegräumen, solange eine Vollbild-Anwendung + läuft, im Akkubetrieb, oder wenn genannte Anwendungen im Vordergrund sind. +* App-Profile… - eine Voreinstellung anwenden, sobald eine bestimmte Anwendung + nach vorn kommt. +* Erinnerungen… - eine Meldung alle so viele Minuten oder zu einer Uhrzeit. +* Anzeigetafel-Modus… - eine Liste von Voreinstellungen auf Zeit durchwechseln, + für einen Rechner, der als Anzeige läuft. Das Hauptfenster kann dabei in die + Taskleiste - aber nur, wenn es eine gibt, die es zurückholen kann. +* Fernsteuerung… - FrontEngine vom Telefon im selben Netzwerk steuern und einen + MIDI-Controller binden. Der Link trägt ein Einmal-Token, das sich bei jedem + Start ändert, und nur die Schaltflächen der Seite lassen sich auslösen. Es + ist einfaches HTTP, lassen Sie es in fremden Netzwerken aus. +* Privatsphäre beim Bildschirmteilen… - Overlays vor einer Bildschirmaufnahme + verbergen, solange eine Meeting-Anwendung offen ist. Verglichen wird mit + Fenstertiteln, damit auch ein Meeting im Browser-Tab erkannt wird. Nur unter + Windows. +* Bildschirmzeit… - wie lange Sie in welcher Anwendung sind. Bleibt auf diesem + Rechner und wird nirgendwohin gesendet. +* Verlauf der Zwischenablage… - was zuletzt kopiert wurde, durchsuchbar, mit + Anheften. Bleibt nur im Arbeitsspeicher, sofern Sie nichts anderes verlangen, + denn in Zwischenablagen stehen oft Passwörter. +* Einstellungen exportieren… / importieren… diff --git a/docs/source/docs/De/particle.rst b/docs/source/docs/De/particle.rst new file mode 100644 index 0000000..a3b72ee --- /dev/null +++ b/docs/source/docs/De/particle.rst @@ -0,0 +1,12 @@ +Partikel-Seite +-------------- + +* Bild wählen - woraus jedes Partikel gezeichnet wird. +* Partikel starten. +* Richtung - nach unten, oben, links oder rechts. +* Partikelgröße, -anzahl, -geschwindigkeit - wie aufwendig der Effekt ist. + Weniger und langsamer kostet weniger; die Qualitätsstufe im Kontrollzentrum + senkt zusätzlich alle Overlays auf einmal. +* Deckkraft - wie durchsichtig die Partikel sind. +* Auf allen Bildschirmen zeigen - eine Kopie je Monitor. +* Zielbildschirm - welcher Bildschirm, oder jedes Mal nachfragen. diff --git a/docs/source/docs/De/pet.rst b/docs/source/docs/De/pet.rst new file mode 100644 index 0000000..434991c --- /dev/null +++ b/docs/source/docs/De/pet.rst @@ -0,0 +1,28 @@ +Haustier-Seite +-------------- + +Ein Begleiter, der auf dem Desktop lebt. + +* Haustier-Bild wählen - ein einzelnes Bild. +* Haustier-Paket wählen… - ein Ordner mit Bildern für walk / idle / sleep / + climb / fall / drag, damit es sich bewegt. +* Ton wählen (optional) - was es abspielt. +* Haustier erzeugen - auf den Bildschirm setzen. Nochmals gedrückt kommt ein + weiteres dazu. +* Größe, Geschwindigkeit. +* Verhalten - auf dem Boden laufen, frei umherstreifen oder dem Cursor folgen. +* An Wänden klettern - an Fensterkanten hochlaufen. +* Auf Fenstern sitzen - auf der Oberkante anderer Fenster rasten. +* Sprechblasen - kurze Bemerkungen je nach Tageszeit, beim Füttern und so fort. +* Laut vorlesen - diese Bemerkungen ausgesprochen. +* Fangen spielen - zwei oder mehr Haustiere jagen einander. +* Auf Audio reagieren - das Haustier bewegt sich zum Ton. Es folgt wahlweise + den **Lautsprechern** oder dem **Mikrofon**; beides liest nur einen Pegel, + eine einzelne Zahl, und nimmt nie auf, was gesagt wird. Nur unter Windows. +* KI-Chat (API-Schlüssel nötig) - mit ihm sprechen. Liest die Umgebungsvariable + ANTHROPIC_API_KEY; der Schlüssel wird nie gespeichert. +* Fokus-Timer (Min.) - eine Arbeitsuhr, die das Haustier für Sie führt, mit + Pausen. + +Ziehen Sie eine Datei auf das Haustier, um es zu füttern, oder ein Bild bzw. +ein Haustier-Paket, um sein Aussehen zu ändern. diff --git a/docs/source/docs/De/presentation.rst b/docs/source/docs/De/presentation.rst new file mode 100644 index 0000000..64b3441 --- /dev/null +++ b/docs/source/docs/De/presentation.rst @@ -0,0 +1,20 @@ +Präsentieren-Seite +------------------ + +* Bildschirm-Annotation - über alles zeichnen, was zu sehen ist. + + * Stift, Textmarker, Radierer, mit Farbe und Breite. + * Rückgängig nimmt den letzten Strich zurück, Löschen alle. + * Während gezeichnet wird, beansprucht diese Ebene die Maus. Alles andere + hier lässt Klicks durch. + +* Cursor hervorheben - Hervorhebung legt einen Ring um den Zeiger, Klick-Welle + zeigt, wo geklickt wurde, Spotlight dunkelt alles andere ab. +* Tastenanzeige - zeigt die gedrückten Tasten, für Aufnahmen und Vorführungen. +* Lupe - folgt dem Cursor, von 1,5x bis 6x. +* Whiteboard - eine endlose Fläche. + + * Mit der mittleren Maustaste ziehen verschiebt, Scrollen zoomt. + * Striche liegen in Flächenkoordinaten, Verschieben und Zoomen lässt sie + also dort, wo sie hingehören. + * „Whiteboard speichern“ schreibt ein Bild genau des bemalten Bereichs. diff --git a/docs/source/docs/De/scene.rst b/docs/source/docs/De/scene.rst new file mode 100644 index 0000000..e619793 --- /dev/null +++ b/docs/source/docs/De/scene.rst @@ -0,0 +1,18 @@ +Szenen-Seite +------------ + +.. image:: ../image/scene/scene.png + +Eine Szene fasst mehrere Overlays zusammen und lässt sich als Datei sichern. + +* Webseite zur Szene hinzufügen - Adresse und Deckkraft. +* Video hinzufügen - Datei, Deckkraft, Geschwindigkeit, Lautstärke. +* Bild hinzufügen - Datei und Deckkraft. +* GIF hinzufügen - Datei, Deckkraft, Geschwindigkeit. +* Ton hinzufügen - Datei und Lautstärke. +* Text hinzufügen - Text, Deckkraft, Schriftgröße, Ausrichtung. +* Szene starten - alles Hinzugefügte anzeigen. +* Szenendatei ausgeben - das Gebaute sichern. +* Szenendatei laden - eine gesicherte Szene zurückholen. +* Alle Skripte löschen - von vorn anfangen. +* Auf allen Bildschirmen zeigen - eine Kopie je Monitor. diff --git a/docs/source/docs/De/screen_care.rst b/docs/source/docs/De/screen_care.rst new file mode 100644 index 0000000..b845433 --- /dev/null +++ b/docs/source/docs/De/screen_care.rst @@ -0,0 +1,13 @@ +Augenschutz-Seite +----------------- + +* Bildschirmfilter - ein warmer, bernsteinfarbener, rosé, gelber, grüner, + blauer oder grauer Schleier über dem Bild, mit einstellbarer Stärke. +* Leselineal - ein Band, das dem Cursor folgt und die Zeile hält. +* Augenpausen (Min. / Sek.) - nach so vielen Minuten wird der Bildschirm so + viele Sekunden abgedunkelt und danach wieder freigegeben. +* Farbsehen - Protanopie, Deuteranopie, Tritanopie oder Achromatopsie + simulieren, um zu prüfen, ob ein Entwurf noch lesbar bleibt. +* Auf allen Bildschirmen / Zielbildschirm - wie sonst auch. + +Diese Overlays lassen Klicks durch, alles darunter funktioniert weiter. diff --git a/docs/source/docs/De/sound.rst b/docs/source/docs/De/sound.rst new file mode 100644 index 0000000..a1a3c41 --- /dev/null +++ b/docs/source/docs/De/sound.rst @@ -0,0 +1,10 @@ +Musik-Seite +----------- + +.. image:: ../image/sound/sound.png + +* wav-Datei wählen. +* Wav abspielen. +* Tondatei wählen - jedes andere Format. +* Abspielen. +* Lautstärke. diff --git a/docs/source/docs/De/text.rst b/docs/source/docs/De/text.rst new file mode 100644 index 0000000..73ed9c0 --- /dev/null +++ b/docs/source/docs/De/text.rst @@ -0,0 +1,22 @@ +Text-Seite +---------- + +.. image:: ../image/text/text.png + +* Text auf dem Bildschirm anzeigen. +* Deckkraft - wie durchsichtig der Text ist. +* Schriftgröße, Schriftart, Farbe - das Aussehen. +* Kontur - ein Rand in Gegenfarbe, damit der Text über allem lesbar bleibt. +* Textausrichtung - eine Ecke oder die Mitte. +* Lauftext - den Text seitlich laufen lassen, mit eigener Geschwindigkeit. +* Textquelle - woher die Wörter kommen. + + * Fester Text - genau das, was im Feld steht. + * Uhr / Datum - ein strftime-Format. + * Countdown - Minuten, HH:MM oder ein vollständiges Datum. + * Stoppuhr - zählt ab dem Start aufwärts. + * Systemwerte - Felder wie {cpu} {ram} {disk} {down} {up}. + * Wetter - Felder wie {temperature} {description} {humidity} {wind}, für + die unter „Wetter-Stadt“ genannte Stadt. + +* Auf allen Bildschirmen / Unter allen Fenstern / Zielbildschirm - wie sonst auch. diff --git a/docs/source/docs/De/tools.rst b/docs/source/docs/De/tools.rst new file mode 100644 index 0000000..343c7a1 --- /dev/null +++ b/docs/source/docs/De/tools.rst @@ -0,0 +1,30 @@ +Werkzeuge-Seite +--------------- + +* Messen - klicken zum Messen, Rechtsklick löscht. Das Gemessene landet direkt + in der Zwischenablage. + + * Farbwähler - die Farbe unter dem Cursor, kopiert als #rrggbb, rgb(...), + hsl(...) oder als CSS-Custom-Property. + * Pixel-Lineal - der Abstand zwischen zwei Punkten. + * Winkelmesser - der Winkel zwischen dreien. + +* Bereichsaufnahme - einen Bereich aufziehen; er landet in der Zwischenablage, + und „Letzte kopieren“ legt ihn erneut dorthin. +* Text lesen - einen Bereich aufziehen, um den Text darin zu kopieren, zu + übersetzen oder eine Frage dazu zu stellen. Dabei geht der aufgenommene + Bereich an die API von Anthropic, weshalb vorher gefragt wird; verwendet wird + Ihr eigener ANTHROPIC_API_KEY. +* Bereichsaufzeichnung - einen Teil des Bildschirms aufzeichnen, mit + einstellbarer Bildrate und Länge, auf Wunsch mit der Kamera in der Ecke. +* Virtuelle Kamera - einen Bereich samt Overlays als Webcam senden, die Zoom, + Teams oder Discord als Videoquelle wählen können. Benötigt das optionale + Paket pyvirtualcam und einen Treiber für virtuelle Kameras; fehlt eines von + beidem, sagt die Schaltfläche das. +* Kamera - jede Videoquelle anzeigen, auch Capture-Karten, als Kreis, + abgerundetes Rechteck oder Rechteck, mit Rahmen und Spiegelung. Sie wird nur + lokal gezeigt, nichts wird aufgezeichnet. +* Fenster anheften… - das Fenster einer anderen Anwendung im Vordergrund halten + und seine Durchsichtigkeit ändern. Nur unter Windows. +* Fensteranordnung - merken, wo die Fenster stehen, und sie später + zurücksetzen. diff --git a/docs/source/docs/De/ui.rst b/docs/source/docs/De/ui.rst new file mode 100644 index 0000000..6578c86 --- /dev/null +++ b/docs/source/docs/De/ui.rst @@ -0,0 +1,40 @@ +Bedienung +--------- + +.. image:: ../image/main/FrontEngine.png + +Menüleiste + +* Sprache - sieben Sprachen: English, 繁體中文, 简体中文, Deutsch, Русский, + Français, Italiano. Die Oberfläche wechselt sofort; ein Neustart ist nicht + nötig, und alles Geöffnete bleibt geöffnet. +* UI-Stil - das Farbschema, wahlweise nach Tag/Nacht-Zeitplan. +* Voreinstellungen - alle Seiteneinstellungen zusammen sichern und später + zurückholen. +* Einstellungen - Tastenkürzel, Tag/Nacht-Design, Autostart, intelligente + Pause, App-Profile, Erinnerungen, Anzeigetafel-Modus, Fernsteuerung, + Privatsphäre beim Bildschirmteilen, Bildschirmzeit und Zwischenablage. +* Hilfe / Dokumentation - Fehlermeldungen und diese Dokumentation. + +Registerkarten + +* VIDEO - ein Video über allem anderen abspielen. +* BILD - ein Bild zeigen oder eine Diashow aus einem Ordner. +* WEBSEITE - eine Webseite zeigen oder mehrere Dashboards durchwechseln. +* GIF UND WEBP - eine Animation zeigen. +* MUSIK - eine wav- oder andere Tondatei abspielen. +* TEXT - Text, Uhr, Countdown, Systemwerte oder Wetter anzeigen. +* SZENE - mehrere davon kombinieren und als Datei sichern. +* PARTIKEL - ein Partikeleffekt über dem Desktop. +* HAUSTIER - ein Begleiter, der läuft, klettert und reagiert. +* AUGENSCHUTZ - Bildschirmfilter, Leselineal, Pausen, Farbsehen-Simulation. +* PRÄSENTIEREN - Annotation, Cursor-Hervorhebung, Tastenanzeige, Lupe, Whiteboard. +* HINTERGRUND - ein bewegter Hintergrund unter allen Fenstern. +* FOKUS - den Hintergrund abdunkeln oder Störendes abdecken. +* WIDGETS - Audio-Spektrum, Systemmonitor, aktuelle Wiedergabe, Notizzettel. +* WERKZEUGE - Messen, Aufnehmen, Text lesen, Aufzeichnen, virtuelle Kamera, + Kamera, Fenster anheften. +* KONTROLLZENTRUM - alle Overlays auf einmal steuern. + +Außer dem Haustier und der Zeichenebene lassen alle Overlays Klicks durch, was +darunter liegt, funktioniert also weiter. diff --git a/docs/source/docs/De/video.rst b/docs/source/docs/De/video.rst new file mode 100644 index 0000000..4ec62e0 --- /dev/null +++ b/docs/source/docs/De/video.rst @@ -0,0 +1,15 @@ +Video-Seite +----------- + +.. image:: ../image/video/video.png + +* Videodatei wählen - die abzuspielende Datei. +* Video abspielen - anzeigen. +* Deckkraft - wie durchsichtig das Video ist. +* Abspielgeschwindigkeit - wie schnell es läuft. +* Lautstärke. +* Vollbild - auf den ganzen Bildschirm strecken. +* Auf allen Bildschirmen zeigen - eine Kopie je Monitor. +* Unter allen Fenstern zeigen - unter die anderen Fenster legen. +* Zielbildschirm - welcher Bildschirm, oder jedes Mal nachfragen. +* Zuletzt verwendet - vorher abgespielte Dateien. diff --git a/docs/source/docs/De/wallpaper.rst b/docs/source/docs/De/wallpaper.rst new file mode 100644 index 0000000..3a3cbe4 --- /dev/null +++ b/docs/source/docs/De/wallpaper.rst @@ -0,0 +1,15 @@ +Hintergrund-Seite +----------------- + +Ein Hintergrund liegt unter allen Fenstern und steht damit nie im Weg. + +* Bildschirm - jeder Bildschirm kann einen eigenen Ordner nutzen. +* Ordner wählen… - wo Bilder oder Videos liegen. +* Wechseln alle - wie lange jedes bleibt, von 30 Sekunden bis zu einer Stunde. +* Zufällig - gemischte Reihenfolge. +* Unterordner einbeziehen. +* Auf Audio reagieren - der Hintergrund folgt dem, was die Lautsprecher + wiedergeben. Gelesen wird ein Pegel, nicht der Ton selbst. Nur unter Windows. +* Ruhezeiten - zwischen den beiden angegebenen Zeiten den Ruhe-Ordner nehmen, + für etwas Ruhigeres während der Arbeit. +* Hintergrund starten / Nächster Hintergrund. diff --git a/docs/source/docs/De/web.rst b/docs/source/docs/De/web.rst new file mode 100644 index 0000000..051be5c --- /dev/null +++ b/docs/source/docs/De/web.rst @@ -0,0 +1,17 @@ +Webseiten-Seite +--------------- + +.. image:: ../image/web/web.png + +* Webseite mit URL öffnen - die Adresse aus dem Feld anzeigen. +* Lokale Datei öffnen - das Feld als Pfad zu einer lokalen html-Datei lesen. +* Eingabe erlauben - der Seite Klicks und Tastatur zugestehen. +* Deckkraft - wie durchsichtig die Seite ist. +* Zoom - von 50% bis 200%. +* Automatisch aktualisieren - alle 30 Sekunden bis alle 15 Minuten neu laden. +* Dashboard-URLs - eine Adresse pro Zeile; Zeilen mit # werden übersprungen. + + * Dashboard starten - der Reihe nach durchwechseln. + * Nächste Seite - sofort weiterschalten. + +* Auf allen Bildschirmen / Unter allen Fenstern / Zielbildschirm - wie sonst auch. diff --git a/docs/source/docs/De/widgets.rst b/docs/source/docs/De/widgets.rst new file mode 100644 index 0000000..23fbaab --- /dev/null +++ b/docs/source/docs/De/widgets.rst @@ -0,0 +1,13 @@ +Widgets-Seite +------------- + +* Audio-Spektrum - Balken oder ein Ring, die sich zum Ton der Lautsprecher + bewegen, mit einstellbarer Bänderzahl. Dies nimmt tatsächlich Ton auf, nur im + Arbeitsspeicher, um Frequenzen zu berechnen; nichts wird aufgezeichnet oder + gesendet, und die Aufnahme endet mit dem Spektrum. Nur unter Windows. +* Systemmonitor - CPU, Speicher, Festplatte und Netzwerk als kleine, stets + sichtbare Anzeige. +* Aktuelle Wiedergabe anzeigen - der Titel, bei dem Ihr Player gerade ist. +* Notizzettel - „Neue Notiz“ legt eine auf den Desktop, „Notizen schließen“ + räumt sie weg. „Meine Notizen beim Start wieder öffnen“ holt sie beim + nächsten Mal zurück. diff --git a/docs/source/docs/Eng/control_center.rst b/docs/source/docs/Eng/control_center.rst index 7da3299..ff0130e 100644 --- a/docs/source/docs/Eng/control_center.rst +++ b/docs/source/docs/Eng/control_center.rst @@ -1,14 +1,26 @@ Control Center Page ----- +------------------- .. image:: ../image/control_center/control_center.png -* Control panel has an area to display error messages and control other instances. - * Close all video button will close all video instance. - * Close all image button will close all image instance. - * Close all gif button will close all gif instance. - * Close all web button will close all web page. - * Close all sound button will close all playing sound instance. - * Close all text will clear all text on screen. - * Clear log will clear error message area. - * Close all will close all instance. \ No newline at end of file +One page that reaches every overlay, including the ones the other tabs opened. + +Closing + +* Close all video / image / gif / web / sound / text - close that kind. +* Close all - close every overlay on screen, whichever page opened it. +* Clear Log - empty the message area on the right. + +Everything at once + +* Hide all / Show all - put the overlays away for a moment and bring them back. +* Mute all - silence everything that makes sound. +* Lock / Unlock overlays - unlocked overlays can be dragged into place with the + mouse and remember where they were dropped; locked ones pass clicks through. +* Chroma key - paint the background a solid colour for keying in OBS or similar. +* Reset overlay positions - put everything back where it started. +* Low power - cut refresh rates and render resolution when the battery matters. +* Quality - High, Balanced or Saver, a finer version of the same idea. +* Hide from capture - keep the overlays on your own screen but leave them out + of what a screen share records. Windows only. A cover from the Focus page + stays visible, since covering something is the one thing it is for. diff --git a/docs/source/docs/Eng/eng_index.rst b/docs/source/docs/Eng/eng_index.rst index a858ce2..795a455 100644 --- a/docs/source/docs/Eng/eng_index.rst +++ b/docs/source/docs/Eng/eng_index.rst @@ -1,5 +1,5 @@ FrontEngine English Documentation ----- +--------------------------------- .. toctree:: :maxdepth: 4 @@ -12,6 +12,15 @@ FrontEngine English Documentation sound.rst text.rst scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst control_center.rst + menus.rst how_to_extend_ui.rst release_process.rst diff --git a/docs/source/docs/Eng/focus.rst b/docs/source/docs/Eng/focus.rst new file mode 100644 index 0000000..94dab47 --- /dev/null +++ b/docs/source/docs/Eng/focus.rst @@ -0,0 +1,13 @@ +Focus Page +---------- + +* Dim background windows - darken everything except the window you are using, + with an adjustable strength. +* Cover a distraction - hide one part of the screen: the bottom strip where the + taskbar lives, the bottom-right corner, the top strip, either side edge, or + the whole screen. +* Target monitor - which screen to use, or ask each time. + +Both pass clicks through: what they cover still works, it just stops competing +for your attention. A cover also stays visible in a screen share, since +covering something is the one thing it is for. diff --git a/docs/source/docs/Eng/gif_and_webp.rst b/docs/source/docs/Eng/gif_and_webp.rst index 1a58afb..7ec8a6d 100644 --- a/docs/source/docs/Eng/gif_and_webp.rst +++ b/docs/source/docs/Eng/gif_and_webp.rst @@ -1,13 +1,14 @@ -GIF & WEBP Page ----- +GIF AND WEBP Page +----------------- .. image:: ../image/gif_and_webp/gif_and_webp.png -* GIF and webp tab have below option: - * Opacity: GIF or webp opacity - * Speed: Gif play rate percentage - * Show on all screen (Show image on all screen) - * Show on all window bottom (Image will hide on all window bottom) -* Buttons - * Choose GIF or webp file (Choose .gif or .webp file) - * Start play gif or web (read options and start play gif or webp) +* Choose GIF or WEBP file - pick the animation. +* Start Play GIF or WEBP - show it. +* Opacity - how see-through it is. +* Speed - how fast it plays. +* Fullscreen - stretch to the whole screen. +* Show on all screen - one copy per monitor. +* Show on all window bottom - place it beneath other windows. +* Target monitor - which screen to use, or ask each time. +* Recent - animations you showed before. diff --git a/docs/source/docs/Eng/how_to_extend_ui.rst b/docs/source/docs/Eng/how_to_extend_ui.rst index 50032b2..9aa19d3 100644 --- a/docs/source/docs/Eng/how_to_extend_ui.rst +++ b/docs/source/docs/Eng/how_to_extend_ui.rst @@ -1,5 +1,5 @@ How to extend FrontEngine UI ----- +---------------------------- .. image:: ../image/main/FrontEngine.png diff --git a/docs/source/docs/Eng/image.rst b/docs/source/docs/Eng/image.rst index 2a8f2dc..a9e2e5f 100644 --- a/docs/source/docs/Eng/image.rst +++ b/docs/source/docs/Eng/image.rst @@ -1,12 +1,20 @@ Image Page ----- +---------- .. image:: ../image/image_page/image_page.png -* Image tab have below option: - * Opacity: Image opacity - * Show on all screen (Show image on all screen) - * Show on all window bottom (Image will hide on all window bottom) -* Buttons - * Choose Image (use to choose image you want to play .jpg .png . webp) - * Start play image (read options and start play image) \ No newline at end of file +* Choose Image - pick the image to show. +* Start Play Image - show it. +* Opacity - how see-through the image is. +* Fullscreen - stretch to the whole screen. +* Show on all screen - one copy per monitor. +* Show on all window bottom - place it beneath other windows. +* Slideshow - show every image in a folder in turn. + + * Choose folder - where the images are. + * Interval - seconds between images. + * Shuffle - random order. + * Include subfolders - look inside nested folders too. + +* Target monitor - which screen to use, or ask each time. +* Recent - images you showed before. diff --git a/docs/source/docs/Eng/menus.rst b/docs/source/docs/Eng/menus.rst new file mode 100644 index 0000000..fa5e064 --- /dev/null +++ b/docs/source/docs/Eng/menus.rst @@ -0,0 +1,46 @@ +Presets and Settings +-------------------- + +Presets menu + +* Save preset... - remember everything the pages are set to, under a name. +* Load preset... - bring one back. +* Delete preset... +* Export preset... / Import preset... - move a preset between machines as a + json file. +* Export package (+media) / Import package (+media) - the same, but with the + images, videos and sounds it refers to, as a zip. +* Set as startup preset... - apply one automatically when FrontEngine starts. +* Import Workshop content... - install presets and pet packs you subscribed to + on Steam. + +Settings menu + +* Hotkeys... - global shortcuts for hide all, show all, close all, mute all, + opacity up and down, next dashboard page and lock. +* Scheduled day/night theme - a light theme by day and a dark one at night. +* Start with the system - launch FrontEngine at login. +* Restore last session - reopen what was on screen last time. +* Load plugins (advanced) - plugins are Python and run with the same rights as + FrontEngine, so only install ones you trust. +* Smart pause... - hide the overlays while a fullscreen application is running, + while on battery, or while named applications have focus. +* App profiles... - apply a preset automatically when a given application comes + to the front. +* Reminders... - a message every so many minutes, or at a time of day. +* Signage mode... - rotate through a list of presets on a timer, for a machine + left running as a display. The main window can go to the tray while it runs - + but only when there is a tray to bring it back from. +* Remote control... - control FrontEngine from a phone on the same network, and + bind a MIDI controller. The link carries a one-time token that changes at + every start, and only the buttons on the page can be triggered. It is plain + HTTP, so leave it off on networks you do not trust. +* Screen-sharing privacy... - hide the overlays from a screen capture while a + meeting application is open. Matched against window titles, so a meeting held + in a browser tab is caught too. Windows only. +* Screen time... - how long you spend in each application. Kept on this machine + and never sent anywhere. +* Clipboard history... - what you copied recently, searchable, with pinning. + Kept in memory unless you ask for it to persist, because clipboards often + hold passwords. +* Export settings... / Import settings... diff --git a/docs/source/docs/Eng/particle.rst b/docs/source/docs/Eng/particle.rst new file mode 100644 index 0000000..40917a6 --- /dev/null +++ b/docs/source/docs/Eng/particle.rst @@ -0,0 +1,12 @@ +Particle Page +------------- + +* Choose Image - the picture each particle is drawn from. +* Start play particle - begin the effect. +* Choose particle direction - down, up, left or right. +* Particle size, Particle count, Particle speed - how heavy the effect is. + Fewer and slower costs less; the Control Center's quality tier can lower it + further for every overlay at once. +* Opacity - how see-through the particles are. +* Show on all screen - one copy per monitor. +* Target monitor - which screen to use, or ask each time. diff --git a/docs/source/docs/Eng/pet.rst b/docs/source/docs/Eng/pet.rst new file mode 100644 index 0000000..c115484 --- /dev/null +++ b/docs/source/docs/Eng/pet.rst @@ -0,0 +1,26 @@ +Pet Page +-------- + +A companion that lives on the desktop. + +* Choose pet sprite - a single image. +* Choose pet pack... - a folder holding walk / idle / sleep / climb / fall / + drag frames, for a pet that animates. +* Choose sound (optional) - a sound it plays. +* Spawn pet - put it on screen. Spawning again adds another one. +* Size, Speed - how big and how fast. +* Behaviour - walk on floor, free wander, or chase the cursor. +* Climb walls - let it climb window edges. +* Sit on windows - let it rest on the top edge of other windows. +* Speech bubbles - short remarks as the day goes on, when it is fed, and so on. +* Speak out loud - read those remarks aloud. +* Play tag with each other - two or more pets chase one another. +* React to audio - the pet moves in time with sound. It can follow your + **speakers** or your **microphone**; either way it reads a level, a single + number, and never captures what is being said. Windows only. +* AI chat (needs API key) - talk to it. This reads the ANTHROPIC_API_KEY + environment variable and the key is never stored. +* Focus timer (min) - a work timer the pet keeps for you, with breaks. + +Drop a file onto the pet to feed it, or drop an image or a pet pack to change +how it looks. diff --git a/docs/source/docs/Eng/presentation.rst b/docs/source/docs/Eng/presentation.rst new file mode 100644 index 0000000..d170456 --- /dev/null +++ b/docs/source/docs/Eng/presentation.rst @@ -0,0 +1,20 @@ +Presenting Page +--------------- + +* Screen annotation - draw over whatever is on screen. + + * Pen, Highlighter, Eraser, with a colour and a width. + * Undo removes the last stroke; Clear removes all of them. + * While drawing is on, this layer takes the mouse. Everything else here + passes clicks through. + +* Cursor emphasis - Highlight puts a ring around the pointer, Click ripple + shows where you clicked, Spotlight darkens everything but the pointer. +* Keystroke display - show the keys you press, for recordings and demos. +* Magnifier - a lens that follows the cursor, from 1.5x to 6x. +* Whiteboard - an endless canvas. + + * Drag with the middle button to pan, scroll to zoom. + * Strokes are kept in canvas coordinates, so panning and zooming leaves + them where they belong. + * Save whiteboard writes an image of the area you actually drew on. diff --git a/docs/source/docs/Eng/release_process.rst b/docs/source/docs/Eng/release_process.rst index 6488993..ea87ff4 100644 --- a/docs/source/docs/Eng/release_process.rst +++ b/docs/source/docs/Eng/release_process.rst @@ -1,5 +1,5 @@ Release Process ----- +--------------- FrontEngine is published to PyPI as ``frontengine`` whenever a pull request is merged into ``main``. Development work happens on the ``dev`` branch and is @@ -9,7 +9,7 @@ Continuous integration and publishing are driven by two GitHub Actions workflows that live in ``.github/workflows/``. Workflows -==== +========= * ``ci.yml`` — *CI* @@ -39,7 +39,7 @@ Workflows touching PyPI, so a run can never republish an existing version. Cutting a release -==== +================= 1. Merge a pull request into ``main``. The patch segment bumps automatically. 2. The workflow publishes to PyPI and creates the GitHub release in one run. @@ -49,7 +49,7 @@ fresh PR — trigger the workflow manually via **Actions → Release → Run workflow** and pick the ``bump`` segment. Required secrets -==== +================ Configure this as a repository secret: diff --git a/docs/source/docs/Eng/scene.rst b/docs/source/docs/Eng/scene.rst index df9bb78..08676b2 100644 --- a/docs/source/docs/Eng/scene.rst +++ b/docs/source/docs/Eng/scene.rst @@ -1,28 +1,18 @@ Scene Page ----- +---------- .. image:: ../image/scene/scene.png -When you switch to the Scene tab, you will notice a sub-tab located below it. -The Scene tab allows you to play multiple scenes simultaneously. +A scene holds several overlays at once and can be saved to a file. -Here’s a breakdown of the available options: - -* Scene Control Panel: - * View the number of scenes you have loaded. - * Save the scene file. - * Start all scenes. -* Image: - * Add an image scene to the scene file. -* GIF and WEBP: - * Include GIF and WEBP scenes in the scene file. -* Text: - * Add a text scene to the scene file. -* Video: - * Incorporate a video scene into the scene file. -* Web: - * Add a web scene to the scene file. -* Sound: - * Include a sound scene in the scene file. -* External UI: - * Add an external UI scene to the scene file. \ No newline at end of file +* Add web to scene - address and opacity. +* Add video to scene - file, opacity, play rate, volume. +* Add image to scene - file and opacity. +* Add gif to scene - file, opacity, speed. +* Add sound to scene - file and volume. +* Add text to scene - text, opacity, font size, alignment. +* Start scene - show everything that was added. +* output scene file - save what you built. +* load scene file - bring a saved scene back. +* clear all script - start again. +* Show on all screen - one copy per monitor. diff --git a/docs/source/docs/Eng/screen_care.rst b/docs/source/docs/Eng/screen_care.rst new file mode 100644 index 0000000..013edcd --- /dev/null +++ b/docs/source/docs/Eng/screen_care.rst @@ -0,0 +1,14 @@ +Eye Care Page +------------- + +* Screen filter - a warm, amber, rose, yellow, green, blue or grey wash over + the screen, with an adjustable Strength. +* Reading ruler - a band that follows the cursor to keep your place in a page + of text. +* Eye breaks (min / sec) - after so many minutes it dims the screen for so many + seconds, then gives it back. +* Colour vision - simulate protanopia, deuteranopia, tritanopia or + achromatopsia, to check whether something you are designing still reads. +* Show on all screen / Target monitor - as elsewhere. + +These overlays pass clicks through, so everything underneath keeps working. diff --git a/docs/source/docs/Eng/sound.rst b/docs/source/docs/Eng/sound.rst index 0453e2e..74c8c92 100644 --- a/docs/source/docs/Eng/sound.rst +++ b/docs/source/docs/Eng/sound.rst @@ -1,10 +1,10 @@ Sound Page ----- +---------- .. image:: ../image/sound/sound.png -* Video tab have below option: - * Volume: Sound volume percentage (100 = 100%) -* Buttons - * Choose wav file (choose .wav file to play) - * Choose sound file (choose0.mp3 .mp4 .wav to play) +* Choose wav file - pick a wav. +* Start Play Wav - play it. +* Choose sound file - pick any other sound format. +* Start Player - play it. +* Volume - sound level. diff --git a/docs/source/docs/Eng/text.rst b/docs/source/docs/Eng/text.rst index 06bc400..a7e8dcb 100644 --- a/docs/source/docs/Eng/text.rst +++ b/docs/source/docs/Eng/text.rst @@ -1,12 +1,22 @@ Text Page ----- +--------- .. image:: ../image/text/text.png -* Text tab have below option: - * Opacity: Text opacity - * Font size: text font size - * Show on all screen (Show image on all screen) - * Show on all window bottom (Image will hide on all window bottom) -* Buttons - * Start draw text on screen (draw text that on input area) \ No newline at end of file +* Start draw text on screen - show the text. +* Opacity - how see-through the text is. +* Font size, Font, Color - how it looks. +* Outline - draw a contrasting edge so it stays readable over anything. +* Choose text alignment - which corner or the centre. +* Marquee - scroll the text sideways, with its own speed. +* Text source - where the words come from. + + * Static text - exactly what is in the box. + * Clock / Date - a strftime format. + * Countdown - minutes, HH:MM, or a full date. + * Stopwatch - counts up from the moment it starts. + * System stats - fields such as {cpu} {ram} {disk} {down} {up}. + * Weather - fields such as {temperature} {description} {humidity} {wind}, + for the city named in Weather city. + +* Show on all screen / Show on all window bottom / Target monitor - as elsewhere. diff --git a/docs/source/docs/Eng/tools.rst b/docs/source/docs/Eng/tools.rst new file mode 100644 index 0000000..17847c7 --- /dev/null +++ b/docs/source/docs/Eng/tools.rst @@ -0,0 +1,27 @@ +Tools Page +---------- + +* Measure - click to measure, right-click to clear. What you measure goes + straight to the clipboard. + + * Colour picker - the colour under the cursor, copied as #rrggbb, + rgb(...), hsl(...) or a CSS custom property. + * Pixel ruler - the distance between two points. + * Protractor - the angle between three. + +* Region capture - drag out an area; it lands on the clipboard, and Copy last + puts it there again. +* Read text - drag out an area to copy the text in it, translate it, or ask a + question about it. This sends the captured area to Anthropic's API, so it + asks for consent first and uses your own ANTHROPIC_API_KEY. +* Record area - record part of the screen, with an adjustable frame rate and + length, optionally with the camera in the corner. +* Virtual camera - send an area, overlays and all, as a webcam that Zoom, Teams + or Discord can pick as their video source. Needs the optional pyvirtualcam + package and a virtual camera driver; without either, the button says so. +* Camera - show any video input, including capture cards, as a circle, rounded + rectangle or rectangle, with an optional border and mirroring. It is shown + locally only and nothing is recorded. +* Pin a window... - keep another application's window on top, and change how + see-through it is. Windows only. +* Window layout - save where your windows are and put them back later. diff --git a/docs/source/docs/Eng/ui.rst b/docs/source/docs/Eng/ui.rst index 7b4e250..7dcaa10 100644 --- a/docs/source/docs/Eng/ui.rst +++ b/docs/source/docs/Eng/ui.rst @@ -1,18 +1,38 @@ How to use ----- +---------- .. image:: ../image/main/FrontEngine.png -* Language Menu (Choose ui language) -* UI Style (Choose ui style) -* Tab Menu - * VIDEO (Setting and show video on front) - * IMAGE (Setting and show image on front) - * WEB (Setting and show web on front) - * GIF AND WEBP (Setting and show gif or webp on front) - * SOUND (Setting and play sound) - * TEXT (Setting and show text on front) - * SCENE (Add multi component on scene and show multi widget, can save setting as file) - * CHAT (Chat with bing on front) - * CONTROL CENTER (Control all another widget) - * IMAGE GENERATION (Generate image by prompt) +Menu bar + +* Language - seven languages: English, 繁體中文, 简体中文, Deutsch, Русский, Français, Italiano. + The interface changes immediately; there is no need to restart, and whatever + you have open stays open. +* UI Style - choose the colour theme. It can also follow a day/night schedule. +* Presets - save everything the pages are set to and bring it back later. +* Settings - hotkeys, scheduled theme, autostart, smart pause, app profiles, + reminders, signage mode, phone remote, screen-sharing privacy, screen time + and clipboard history. +* Help / Doc - issue tracker and this documentation. + +Tabs + +* VIDEO - play a video on top of everything. +* IMAGE - show an image, or a slideshow from a folder. +* WEB - show a web page, or rotate through a set of dashboards. +* GIF AND WEBP - show an animation. +* SOUND - play a wav or any other sound file. +* TEXT - draw text, a clock, a countdown, system stats or the weather. +* SCENE - combine several of the above and save the result as a file. +* PARTICLE - a particle effect over the desktop. +* PET - a desktop companion that walks, climbs and reacts to you. +* EYE CARE - screen filter, reading ruler, break reminders, colour-vision simulation. +* PRESENTING - annotation, cursor emphasis, keystroke display, magnifier, whiteboard. +* WALLPAPER - an animated wallpaper below every window. +* FOCUS - dim the background or cover something distracting. +* WIDGETS - audio spectrum, system monitor, now playing, sticky notes. +* TOOLS - measure, capture, read text, record, virtual camera, camera, window pinning. +* CONTROL CENTER - control every overlay at once. + +Every overlay except the pet and the annotation layer passes clicks straight +through, so what is underneath keeps working. diff --git a/docs/source/docs/Eng/video.rst b/docs/source/docs/Eng/video.rst index 262c5a9..524cc44 100644 --- a/docs/source/docs/Eng/video.rst +++ b/docs/source/docs/Eng/video.rst @@ -1,14 +1,15 @@ Video Page ----- +---------- .. image:: ../image/video/video.png -* Video tab have below option: - * Opacity: Video opacity - * Play rate: Video play rate percentage (100 = 100%) - * Volume: Video volume percentage (100 = 100%) - * Show on all screen (Show video on all screen) - * Show on all window bottom (Video will hide on all window bottom) -* Buttons - * Choose video file (use to choose video you want to play .mp4) - * Start play video (read options and start play video) \ No newline at end of file +* Choose video file - pick the file to play. +* Start Play Video - show it. +* Opacity - how see-through the video is. +* Play rate - playback speed. +* Volume - sound level. +* Fullscreen - stretch to the whole screen. +* Show on all screen - one copy per monitor. +* Show on all window bottom - place it beneath other windows. +* Target monitor - which screen to use, or ask each time. +* Recent - files you played before. diff --git a/docs/source/docs/Eng/wallpaper.rst b/docs/source/docs/Eng/wallpaper.rst new file mode 100644 index 0000000..c0ce844 --- /dev/null +++ b/docs/source/docs/Eng/wallpaper.rst @@ -0,0 +1,15 @@ +Wallpaper Page +-------------- + +A wallpaper sits below every window, so it never gets in the way. + +* Monitor - each screen can use its own folder. +* Choose folder... - where the images or videos are. +* Change every - how long each one stays, from 30 seconds to an hour. +* Shuffle - random order. +* Include subfolders - look inside nested folders too. +* React to audio - the wallpaper responds to what your speakers are playing. + This reads a level, not the sound itself. Windows only. +* Quiet hours - between the two times given, switch to the Quiet folder + instead, for something calmer while you work. +* Start wallpaper / Next wallpaper - begin, or move on now. diff --git a/docs/source/docs/Eng/web.rst b/docs/source/docs/Eng/web.rst index 123e3b9..d68d85a 100644 --- a/docs/source/docs/Eng/web.rst +++ b/docs/source/docs/Eng/web.rst @@ -1,13 +1,17 @@ -Web Page ----- +WEB Page +-------- .. image:: ../image/web/web.png -* Web tab have below option: - * Opacity: WEB opacity - * Open local file (open local HTML file ) - * Enable input (Enable web page input) - * Show on all screen (Show image on all screen) - * Show on all window bottom (Image will hide on all window bottom) -* Buttons - * Open web with url (open url that input on input area) \ No newline at end of file +* Open web with url - show the address in the box. +* Open local file - treat the box as a path to a local html file. +* Enable input - let the page receive clicks and typing. +* Opacity - how see-through the page is. +* Zoom - page zoom, from 50% to 200%. +* Auto refresh - reload every 30 seconds up to every 15 minutes. +* Dashboard URLs - one address per line; lines starting with # are ignored. + + * Start dashboard - rotate through those addresses. + * Next page - move to the next one now. + +* Show on all screen / Show on all window bottom / Target monitor - as on the other pages. diff --git a/docs/source/docs/Eng/widgets.rst b/docs/source/docs/Eng/widgets.rst new file mode 100644 index 0000000..267a623 --- /dev/null +++ b/docs/source/docs/Eng/widgets.rst @@ -0,0 +1,11 @@ +Widgets Page +------------ + +* Audio spectrum - bars or a ring that move with what your speakers play, with + an adjustable number of bands. This one does capture audio, in memory only, + to compute frequencies; nothing is recorded or sent, and capture stops when + you stop the spectrum. Windows only. +* System monitor - CPU, memory, disk and network as a small always-visible panel. +* Show now playing - the track your media player is on. +* Sticky note - New note puts a note on the desktop; Close notes clears them. + Reopen my notes when FrontEngine starts brings them back next time. diff --git a/docs/source/docs/Fr/control_center.rst b/docs/source/docs/Fr/control_center.rst new file mode 100644 index 0000000..bc03466 --- /dev/null +++ b/docs/source/docs/Fr/control_center.rst @@ -0,0 +1,30 @@ +Page Centre de contrôle +----------------------- + +.. image:: ../image/control_center/control_center.png + +Une page qui atteint chaque calque, y compris ceux ouverts par les autres +onglets. + +Fermeture + +* Fermer toutes les vidéos / images / GIF / pages / sons / textes - ce type-là + seulement. +* Tout fermer - chaque calque à l'écran, quelle que soit la page qui l'a ouvert. +* Effacer le journal - vider la zone de messages à droite. + +Tout d'un coup + +* Tout masquer / Tout afficher - ranger un instant, puis récupérer. +* Tout couper - faire taire ce qui produit du son. +* Verrouiller / déverrouiller les calques - déverrouillés, ils se déplacent à la + souris et retiennent où on les a déposés ; verrouillés, ils laissent passer + les clics. +* Fond vert - peindre le fond d'une couleur unie pour l'incruster dans OBS ou + équivalent. +* Réinitialiser la position des calques - tout remettre où c'était au départ. +* Mode économie - baisser la cadence et la résolution quand la batterie compte. +* Qualité - Élevée, Équilibrée ou Économie : la même idée, en plus fin. +* Masquer de la capture - les calques restent sur votre écran mais disparaissent + de ce qu'enregistre un partage d'écran. Windows uniquement. Un cache de la page + Concentration reste visible, puisque recouvrir est sa seule raison d'être. diff --git a/docs/source/docs/Fr/focus.rst b/docs/source/docs/Fr/focus.rst new file mode 100644 index 0000000..1d65ab8 --- /dev/null +++ b/docs/source/docs/Fr/focus.rst @@ -0,0 +1,13 @@ +Page Concentration +------------------ + +* Assombrir les fenêtres d'arrière-plan - atténuer tout sauf la fenêtre en + cours, avec une intensité réglable. +* Masquer une distraction - cacher une partie de l'écran : la bande inférieure + où se trouve la barre des tâches, le coin inférieur droit, la bande + supérieure, l'un des bords latéraux, ou tout l'écran. +* Écran cible - quel écran utiliser, ou demander à chaque fois. + +Les deux laissent passer les clics : ce qu'ils recouvrent fonctionne toujours, +cela cesse simplement de réclamer votre attention. Un cache reste par ailleurs +visible dans un partage d'écran, puisque recouvrir est sa seule raison d'être. diff --git a/docs/source/docs/Fr/fr_index.rst b/docs/source/docs/Fr/fr_index.rst new file mode 100644 index 0000000..a531938 --- /dev/null +++ b/docs/source/docs/Fr/fr_index.rst @@ -0,0 +1,28 @@ +Documentation FrontEngine en français +------------------------------------- + +.. toctree:: + :maxdepth: 4 + + ui.rst + video.rst + image.rst + web.rst + gif_and_webp.rst + sound.rst + text.rst + scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst + control_center.rst + menus.rst + +---- + +La documentation pour les contributeurs - étendre l'interface, processus de publication - n'existe pour l'instant qu'en anglais, voir English Documentation. diff --git a/docs/source/docs/Fr/gif_and_webp.rst b/docs/source/docs/Fr/gif_and_webp.rst new file mode 100644 index 0000000..66b1352 --- /dev/null +++ b/docs/source/docs/Fr/gif_and_webp.rst @@ -0,0 +1,14 @@ +Page GIF et WEBP +---------------- + +.. image:: ../image/gif_and_webp/gif_and_webp.png + +* Choisir un fichier GIF ou WEBP - l'animation. +* Lancer le GIF ou WEBP - l'afficher. +* Opacité - à quel point elle est translucide. +* Vitesse - à quelle allure elle défile. +* Plein écran - étirer sur tout l'écran. +* Afficher sur tous les écrans - une copie par moniteur. +* Afficher sous toutes les fenêtres - la placer sous les autres fenêtres. +* Écran cible - quel écran utiliser, ou demander à chaque fois. +* Récents - les animations déjà affichées. diff --git a/docs/source/docs/Fr/image.rst b/docs/source/docs/Fr/image.rst new file mode 100644 index 0000000..160e09d --- /dev/null +++ b/docs/source/docs/Fr/image.rst @@ -0,0 +1,20 @@ +Page Image +---------- + +.. image:: ../image/image_page/image_page.png + +* Choisir une image - l'image à afficher. +* Afficher l'image. +* Opacité - à quel point l'image est translucide. +* Plein écran - étirer sur tout l'écran. +* Afficher sur tous les écrans - une copie par moniteur. +* Afficher sous toutes les fenêtres - la placer sous les autres fenêtres. +* Diaporama - afficher tour à tour toutes les images d'un dossier. + + * Choisir un dossier - où se trouvent les images. + * Intervalle - secondes par image. + * Aléatoire - ordre mélangé. + * Inclure les sous-dossiers. + +* Écran cible - quel écran utiliser, ou demander à chaque fois. +* Récents - les images déjà affichées. diff --git a/docs/source/docs/Fr/menus.rst b/docs/source/docs/Fr/menus.rst new file mode 100644 index 0000000..2777769 --- /dev/null +++ b/docs/source/docs/Fr/menus.rst @@ -0,0 +1,49 @@ +Préréglages et réglages +----------------------- + +Menu Préréglages + +* Enregistrer un préréglage… - les réglages de toutes les pages, sous un nom. +* Charger un préréglage… - le retrouver. +* Supprimer un préréglage… +* Exporter… / Importer… - déplacer d'une machine à l'autre en json. +* Exporter un paquet (+médias) / Importer un paquet (+médias) - la même chose, + mais avec les images, vidéos et sons utilisés, en zip. +* Définir comme préréglage de démarrage… - l'appliquer au lancement. +* Importer du contenu Workshop… - installer les préréglages et packs de mascotte + auxquels vous êtes abonné sur Steam. + +Menu Réglages + +* Raccourcis clavier… - raccourcis globaux pour tout masquer, tout afficher, + tout fermer, tout couper, l'opacité, la page suivante du tableau de bord et le + verrouillage. +* Thème jour/nuit programmé - clair le jour, sombre la nuit. +* Lancer au démarrage du système - ouvrir FrontEngine à l'ouverture de session. +* Restaurer la dernière session - rouvrir ce qui était affiché la dernière fois. +* Charger des extensions (avancé) - les extensions sont du Python et tournent + avec les mêmes droits que FrontEngine ; n'installez que ce en quoi vous avez + confiance. +* Pause intelligente… - ranger les calques pendant qu'une application est en + plein écran, sur batterie, ou quand des applications nommées sont au premier + plan. +* Profils d'application… - appliquer un préréglage dès qu'une application donnée + passe devant. +* Rappels… - un message toutes les tant de minutes, ou à une heure donnée. +* Mode affichage… - faire défiler une liste de préréglages sur minuterie, pour + une machine laissée en vitrine. La fenêtre principale peut alors partir dans + la zone de notification - mais seulement s'il y en a une pour la ramener. +* Télécommande… - piloter FrontEngine depuis un téléphone du même réseau, et + associer un contrôleur MIDI. Le lien porte un jeton à usage unique qui change + à chaque démarrage, et seuls les boutons de la page peuvent être déclenchés. + C'est du HTTP en clair : laissez-la désactivée sur les réseaux inconnus. +* Confidentialité du partage d'écran… - masquer les calques d'une capture tant + qu'une application de réunion est ouverte. La comparaison porte sur les titres + de fenêtres, ce qui attrape aussi une réunion dans un onglet. Windows + uniquement. +* Temps d'écran… - le temps passé dans chaque application. Reste sur cette + machine et n'est envoyé nulle part. +* Historique du presse-papiers… - ce que vous avez copié récemment, avec + recherche et épinglage. Gardé en mémoire seulement sauf demande contraire, car + les presse-papiers contiennent souvent des mots de passe. +* Exporter les réglages… / Importer les réglages… diff --git a/docs/source/docs/Fr/particle.rst b/docs/source/docs/Fr/particle.rst new file mode 100644 index 0000000..ae008f6 --- /dev/null +++ b/docs/source/docs/Fr/particle.rst @@ -0,0 +1,12 @@ +Page Particules +--------------- + +* Choisir une image - le motif de chaque particule. +* Lancer les particules. +* Direction - vers le bas, le haut, la gauche ou la droite. +* Taille, nombre et vitesse des particules - le poids de l'effet. + Moins et plus lent coûte moins ; la qualité, dans le Centre de contrôle, + abaisse encore tous les calques d'un coup. +* Opacité - à quel point les particules sont translucides. +* Afficher sur tous les écrans - une copie par moniteur. +* Écran cible - quel écran utiliser, ou demander à chaque fois. diff --git a/docs/source/docs/Fr/pet.rst b/docs/source/docs/Fr/pet.rst new file mode 100644 index 0000000..6ec9922 --- /dev/null +++ b/docs/source/docs/Fr/pet.rst @@ -0,0 +1,30 @@ +Page Mascotte +------------- + +Un compagnon qui vit sur le bureau. + +* Choisir l'image de la mascotte - une seule image. +* Choisir un pack de mascotte… - un dossier contenant les images walk / idle / + sleep / climb / fall / drag, pour qu'elle s'anime. +* Choisir un son (facultatif) - ce qu'elle joue. +* Faire apparaître la mascotte - la poser à l'écran. Une nouvelle pression en + ajoute une autre. +* Taille, vitesse. +* Comportement - marcher au sol, errer librement, ou suivre le curseur. +* Grimper aux murs - le long des bords de fenêtres. +* S'asseoir sur les fenêtres - se poser sur le bord supérieur des autres fenêtres. +* Bulles de dialogue - de courtes remarques au fil de la journée, quand on la + nourrit, et ainsi de suite. +* Lire à voix haute - dire ces remarques. +* Jouer à chat - deux mascottes ou plus se poursuivent. +* Réagir au son - la mascotte bouge en rythme. Elle peut suivre vos + **haut-parleurs** ou votre **microphone** ; dans les deux cas elle ne lit + qu'un niveau, un simple nombre, et n'enregistre jamais ce qui est dit. + Windows uniquement. +* Discussion IA (clé API requise) - lui parler. Cela lit la variable + d'environnement ANTHROPIC_API_KEY ; la clé n'est jamais enregistrée. +* Minuteur de concentration (min) - un minuteur de travail que la mascotte tient + pour vous, avec des pauses. + +Déposez un fichier sur la mascotte pour la nourrir, ou une image ou un pack +pour changer son apparence. diff --git a/docs/source/docs/Fr/presentation.rst b/docs/source/docs/Fr/presentation.rst new file mode 100644 index 0000000..71a4356 --- /dev/null +++ b/docs/source/docs/Fr/presentation.rst @@ -0,0 +1,22 @@ +Page Présentation +----------------- + +* Annotation à l'écran - dessiner par-dessus ce qui est affiché. + + * Stylo, surligneur, gomme, avec une couleur et une épaisseur. + * « Annuler » retire le dernier trait, « Effacer » les retire tous. + * Tant que le dessin est actif, ce calque prend la souris. Tout le reste + ici laisse passer les clics. + +* Mise en valeur du curseur - le halo entoure le pointeur, l'onde au clic + montre où vous avez cliqué, le projecteur assombrit tout le reste. +* Affichage des touches - montre les touches frappées, utile en démonstration. +* Loupe - suit le curseur, de 1,5x à 6x. +* Tableau blanc - une toile sans fin. + + * Faites glisser avec le bouton du milieu pour vous déplacer, la molette + pour zoomer. + * Les traits sont conservés en coordonnées de la toile : se déplacer et + zoomer les laisse là où ils doivent être. + * « Enregistrer le tableau blanc » écrit une image de la zone réellement + dessinée. diff --git a/docs/source/docs/Fr/scene.rst b/docs/source/docs/Fr/scene.rst new file mode 100644 index 0000000..974214f --- /dev/null +++ b/docs/source/docs/Fr/scene.rst @@ -0,0 +1,18 @@ +Page Scène +---------- + +.. image:: ../image/scene/scene.png + +Une scène réunit plusieurs calques et s'enregistre dans un fichier. + +* Ajouter une page web - adresse et opacité. +* Ajouter une vidéo - fichier, opacité, vitesse, volume. +* Ajouter une image - fichier et opacité. +* Ajouter un GIF - fichier, opacité, vitesse. +* Ajouter un son - fichier et volume. +* Ajouter du texte - texte, opacité, taille, alignement. +* Démarrer la scène - afficher tout ce qui a été ajouté. +* Exporter le fichier de scène. +* Charger un fichier de scène - retrouver une scène enregistrée. +* Effacer tous les scripts - repartir de zéro. +* Afficher sur tous les écrans - une copie par moniteur. diff --git a/docs/source/docs/Fr/screen_care.rst b/docs/source/docs/Fr/screen_care.rst new file mode 100644 index 0000000..ac80f5c --- /dev/null +++ b/docs/source/docs/Fr/screen_care.rst @@ -0,0 +1,14 @@ +Page Confort visuel +------------------- + +* Filtre d'écran - un voile chaud, ambre, rosé, jaune, vert, bleu ou gris sur + l'écran, d'intensité réglable. +* Règle de lecture - une bande qui suit le curseur pour garder sa ligne. +* Pauses visuelles (min / s) - au bout de tant de minutes l'écran s'assombrit + pendant tant de secondes, puis vous le rend. +* Vision des couleurs - simuler protanopie, deutéranopie, tritanopie ou + achromatopsie, pour vérifier qu'une maquette reste lisible. +* Tous les écrans / Écran cible - comme ailleurs. + +Ces calques laissent passer les clics : tout ce qui est dessous continue de +fonctionner. diff --git a/docs/source/docs/Fr/sound.rst b/docs/source/docs/Fr/sound.rst new file mode 100644 index 0000000..0f0d69b --- /dev/null +++ b/docs/source/docs/Fr/sound.rst @@ -0,0 +1,10 @@ +Page Musique +------------ + +.. image:: ../image/sound/sound.png + +* Choisir un fichier wav. +* Lire le wav. +* Choisir un fichier son - tout autre format. +* Lire. +* Volume. diff --git a/docs/source/docs/Fr/text.rst b/docs/source/docs/Fr/text.rst new file mode 100644 index 0000000..64cd375 --- /dev/null +++ b/docs/source/docs/Fr/text.rst @@ -0,0 +1,22 @@ +Page Texte +---------- + +.. image:: ../image/text/text.png + +* Afficher le texte à l'écran. +* Opacité - à quel point le texte est translucide. +* Taille, police, couleur - son apparence. +* Contour - un liseré contrasté pour rester lisible sur n'importe quel fond. +* Alignement du texte - vers un coin ou au centre. +* Défilement - faire glisser le texte sur le côté, à sa propre vitesse. +* Source du texte - d'où viennent les mots. + + * Texte fixe - exactement ce qui est dans le champ. + * Horloge / Date - un format strftime. + * Compte à rebours - minutes, HH:MM, ou une date complète. + * Chronomètre - compte à partir du démarrage. + * État du système - des champs comme {cpu} {ram} {disk} {down} {up}. + * Météo - des champs comme {temperature} {description} {humidity} {wind}, + pour la ville indiquée dans « Ville pour la météo ». + +* Tous les écrans / Sous toutes les fenêtres / Écran cible - comme ailleurs. diff --git a/docs/source/docs/Fr/tools.rst b/docs/source/docs/Fr/tools.rst new file mode 100644 index 0000000..c444fcf --- /dev/null +++ b/docs/source/docs/Fr/tools.rst @@ -0,0 +1,29 @@ +Page Outils +----------- + +* Mesurer - cliquez pour mesurer, le clic droit efface. Ce que vous mesurez part + directement dans le presse-papiers. + + * Pipette - la couleur sous le curseur, copiée en #rrggbb, rgb(...), + hsl(...) ou en propriété CSS personnalisée. + * Règle en pixels - la distance entre deux points. + * Rapporteur - l'angle entre trois. + +* Capture de zone - tracez une zone ; elle arrive dans le presse-papiers, et + « Copier la dernière » l'y remet. +* Lire du texte - tracez une zone pour en copier le texte, le traduire, ou poser + une question à son sujet. Cela envoie la zone capturée à l'API d'Anthropic : + votre accord est donc demandé d'abord, et c'est votre propre ANTHROPIC_API_KEY + qui est utilisée. +* Enregistrement de zone - enregistrer une partie de l'écran, avec une cadence + et une durée réglables, éventuellement avec la caméra dans un coin. +* Caméra virtuelle - envoyer une zone, calques compris, comme une webcam que + Zoom, Teams ou Discord peuvent choisir comme source vidéo. Nécessite le paquet + optionnel pyvirtualcam et un pilote de caméra virtuelle ; à défaut, le bouton + le dit. +* Caméra - afficher n'importe quelle entrée vidéo, y compris les cartes + d'acquisition, en cercle, rectangle arrondi ou rectangle, avec bordure et + miroir. Elle n'est affichée qu'en local et rien n'est enregistré. +* Épingler une fenêtre… - garder la fenêtre d'une autre application au premier + plan et régler sa transparence. Windows uniquement. +* Disposition des fenêtres - retenir où sont les fenêtres et les y remettre. diff --git a/docs/source/docs/Fr/ui.rst b/docs/source/docs/Fr/ui.rst new file mode 100644 index 0000000..0c34f1b --- /dev/null +++ b/docs/source/docs/Fr/ui.rst @@ -0,0 +1,43 @@ +Comment l'utiliser +------------------ + +.. image:: ../image/main/FrontEngine.png + +Barre de menus + +* Choisir la langue - sept langues : English, 繁體中文, 简体中文, Deutsch, + Русский, Français, Italiano. L'interface change immédiatement ; aucun + redémarrage n'est nécessaire et tout ce qui est ouvert le reste. +* Style de l'interface - le thème de couleurs, éventuellement selon un horaire + jour/nuit. +* Préréglages - enregistrer d'un bloc les réglages de toutes les pages et les + retrouver plus tard. +* Réglages - raccourcis, thème programmé, démarrage automatique, pause + intelligente, profils d'application, rappels, mode affichage, télécommande, + confidentialité du partage d'écran, temps d'écran et presse-papiers. +* Aide / Documentation - le suivi des problèmes et cette documentation. + +Onglets + +* VIDÉO - lire une vidéo par-dessus tout le reste. +* IMAGE - afficher une image, ou un diaporama depuis un dossier. +* WEB - afficher une page web, ou faire défiler plusieurs tableaux de bord. +* GIF ET WEBP - afficher une animation. +* MUSIQUE - lire un wav ou tout autre fichier son. +* TEXTE - afficher du texte, une horloge, un compte à rebours, l'état du + système ou la météo. +* SCÈNE - combiner plusieurs des éléments ci-dessus et enregistrer le résultat. +* PARTICULES - un effet de particules sur le bureau. +* MASCOTTE - un compagnon qui marche, grimpe et vous répond. +* CONFORT VISUEL - filtre d'écran, règle de lecture, pauses, vision des couleurs. +* PRÉSENTATION - annotation, mise en valeur du curseur, affichage des touches, + loupe, tableau blanc. +* FOND D'ÉCRAN - un fond animé sous toutes les fenêtres. +* CONCENTRATION - assombrir l'arrière-plan ou masquer une distraction. +* WIDGETS - spectre audio, moniteur système, lecture en cours, pense-bêtes. +* OUTILS - mesurer, capturer, lire du texte, enregistrer, caméra virtuelle, + caméra, épinglage de fenêtres. +* CENTRE DE CONTRÔLE - piloter tous les calques d'un coup. + +Sauf la mascotte et le calque de dessin, tous les calques laissent passer les +clics : ce qui se trouve dessous continue de fonctionner. diff --git a/docs/source/docs/Fr/video.rst b/docs/source/docs/Fr/video.rst new file mode 100644 index 0000000..5e2f92b --- /dev/null +++ b/docs/source/docs/Fr/video.rst @@ -0,0 +1,15 @@ +Page Vidéo +---------- + +.. image:: ../image/video/video.png + +* Choisir un fichier vidéo - le fichier à lire. +* Lancer la vidéo - l'afficher. +* Opacité - à quel point la vidéo est translucide. +* Vitesse de lecture. +* Volume. +* Plein écran - étirer sur tout l'écran. +* Afficher sur tous les écrans - une copie par moniteur. +* Afficher sous toutes les fenêtres - la placer sous les autres fenêtres. +* Écran cible - quel écran utiliser, ou demander à chaque fois. +* Récents - les fichiers déjà lus. diff --git a/docs/source/docs/Fr/wallpaper.rst b/docs/source/docs/Fr/wallpaper.rst new file mode 100644 index 0000000..3f6041c --- /dev/null +++ b/docs/source/docs/Fr/wallpaper.rst @@ -0,0 +1,15 @@ +Page Fond d'écran +----------------- + +Un fond d'écran se place sous toutes les fenêtres : il ne gêne donc jamais. + +* Écran - chaque écran peut utiliser son propre dossier. +* Choisir un dossier… - où se trouvent les images ou les vidéos. +* Changer toutes les - combien de temps chacune reste, de 30 secondes à 1 heure. +* Aléatoire - ordre mélangé. +* Inclure les sous-dossiers. +* Réagir au son - le fond répond à ce que jouent vos haut-parleurs. Il en lit un + niveau, pas le son lui-même. Windows uniquement. +* Heures calmes - entre les deux heures indiquées, passer au dossier « calme », + pour quelque chose de plus sobre pendant le travail. +* Démarrer le fond d'écran / Fond d'écran suivant. diff --git a/docs/source/docs/Fr/web.rst b/docs/source/docs/Fr/web.rst new file mode 100644 index 0000000..79c7484 --- /dev/null +++ b/docs/source/docs/Fr/web.rst @@ -0,0 +1,18 @@ +Page Web +-------- + +.. image:: ../image/web/web.png + +* Ouvrir une page par son adresse - afficher l'adresse saisie. +* Ouvrir un fichier local - lire le champ comme un chemin vers un html local. +* Autoriser la saisie - laisser la page recevoir clics et frappes. +* Opacité - à quel point la page est translucide. +* Zoom - de 50% à 200%. +* Actualisation automatique - recharger toutes les 30 secondes à 15 minutes. +* URL du tableau de bord - une adresse par ligne ; les lignes commençant par # + sont ignorées. + + * Démarrer le tableau de bord - faire défiler ces adresses. + * Page suivante - passer à la suivante tout de suite. + +* Tous les écrans / Sous toutes les fenêtres / Écran cible - comme ailleurs. diff --git a/docs/source/docs/Fr/widgets.rst b/docs/source/docs/Fr/widgets.rst new file mode 100644 index 0000000..a9bfd5d --- /dev/null +++ b/docs/source/docs/Fr/widgets.rst @@ -0,0 +1,13 @@ +Page Widgets +------------ + +* Spectre audio - des barres ou un anneau qui suivent ce que jouent les + haut-parleurs, avec un nombre de bandes réglable. Celui-ci capte réellement + l'audio, en mémoire seulement, pour en calculer les fréquences ; rien n'est + enregistré ni envoyé, et la capture s'arrête avec le spectre. Windows + uniquement. +* Moniteur système - processeur, mémoire, disque et réseau dans un petit + panneau toujours visible. +* Afficher la lecture en cours - le morceau où en est votre lecteur. +* Pense-bête - « Nouvelle note » en pose une sur le bureau, « Fermer les notes » + les retire. « Rouvrir mes notes au démarrage » les ramène la fois suivante. diff --git a/docs/source/docs/It/control_center.rst b/docs/source/docs/It/control_center.rst new file mode 100644 index 0000000..13be820 --- /dev/null +++ b/docs/source/docs/It/control_center.rst @@ -0,0 +1,29 @@ +Pagina Centro di controllo +-------------------------- + +.. image:: ../image/control_center/control_center.png + +Una pagina che raggiunge ogni overlay, compresi quelli aperti dalle altre +schede. + +Chiusura + +* Chiudi tutti i video / immagini / GIF / pagine / suoni / testi - solo quel tipo. +* Chiudi tutto - ogni overlay sullo schermo, da qualunque pagina sia stato aperto. +* Cancella il log - svuotare l'area dei messaggi a destra. + +Tutto insieme + +* Nascondi tutto / Mostra tutto - metterli via un momento e riprenderli. +* Disattiva tutto l'audio - far tacere tutto ciò che suona. +* Blocca / sblocca gli overlay - sbloccati si trascinano col mouse dove si vuole + e ricordano dove sono stati lasciati; bloccati lasciano passare i clic. +* Chroma key - dipingere lo sfondo di un colore pieno per la chiave in OBS e + simili. +* Reimposta la posizione degli overlay - rimettere tutto dov'era all'inizio. +* Risparmio energetico - abbassare frequenza e risoluzione quando conta la + batteria. +* Qualità - Alta, Bilanciata o Risparmio: la stessa idea, più fine. +* Nascondi dalla cattura - gli overlay restano sul tuo schermo ma spariscono da + ciò che registra una condivisione. Solo su Windows. Una copertura della pagina + Concentrazione resta visibile, dato che coprire è la sua unica ragione d'essere. diff --git a/docs/source/docs/It/focus.rst b/docs/source/docs/It/focus.rst new file mode 100644 index 0000000..0b719de --- /dev/null +++ b/docs/source/docs/It/focus.rst @@ -0,0 +1,14 @@ +Pagina Concentrazione +--------------------- + +* Oscura le finestre sullo sfondo - attenuare tutto tranne la finestra in uso, + con intensità regolabile. +* Copri una distrazione - nascondere una parte dello schermo: la striscia + inferiore con la barra delle applicazioni, l'angolo in basso a destra, la + striscia superiore, uno dei bordi laterali, o tutto lo schermo. +* Schermo di destinazione - quale schermo usare, o chiedere ogni volta. + +Entrambi lasciano passare i clic: ciò che coprono continua a funzionare, +semplicemente smette di reclamare la tua attenzione. Una copertura inoltre resta +visibile in una condivisione schermo, dato che coprire è la sua unica ragione +d'essere. diff --git a/docs/source/docs/It/gif_and_webp.rst b/docs/source/docs/It/gif_and_webp.rst new file mode 100644 index 0000000..a459f7a --- /dev/null +++ b/docs/source/docs/It/gif_and_webp.rst @@ -0,0 +1,14 @@ +Pagina GIF e WEBP +----------------- + +.. image:: ../image/gif_and_webp/gif_and_webp.png + +* Scegli file GIF o WEBP - l'animazione. +* Avvia GIF o WEBP - mostrarla. +* Opacità - quanto è trasparente. +* Velocità - quanto va veloce. +* Schermo intero - allargare a tutto lo schermo. +* Mostra su tutti gli schermi - una copia per monitor. +* Mostra sotto tutte le finestre - collocarla sotto le altre finestre. +* Schermo di destinazione - quale schermo usare, o chiedere ogni volta. +* Recenti - le animazioni già mostrate. diff --git a/docs/source/docs/It/image.rst b/docs/source/docs/It/image.rst new file mode 100644 index 0000000..87a9999 --- /dev/null +++ b/docs/source/docs/It/image.rst @@ -0,0 +1,20 @@ +Pagina Immagine +--------------- + +.. image:: ../image/image_page/image_page.png + +* Scegli immagine - l'immagine da mostrare. +* Mostra immagine. +* Opacità - quanto l'immagine è trasparente. +* Schermo intero - allargare a tutto lo schermo. +* Mostra su tutti gli schermi - una copia per monitor. +* Mostra sotto tutte le finestre - collocarla sotto le altre finestre. +* Presentazione - mostrare a turno ogni immagine di una cartella. + + * Scegli cartella - dove stanno le immagini. + * Intervallo - secondi per immagine. + * Casuale - ordine mescolato. + * Includi le sottocartelle. + +* Schermo di destinazione - quale schermo usare, o chiedere ogni volta. +* Recenti - le immagini già mostrate. diff --git a/docs/source/docs/It/it_index.rst b/docs/source/docs/It/it_index.rst new file mode 100644 index 0000000..7d6ad81 --- /dev/null +++ b/docs/source/docs/It/it_index.rst @@ -0,0 +1,28 @@ +Documentazione FrontEngine in italiano +-------------------------------------- + +.. toctree:: + :maxdepth: 4 + + ui.rst + video.rst + image.rst + web.rst + gif_and_webp.rst + sound.rst + text.rst + scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst + control_center.rst + menus.rst + +---- + +La documentazione per chi contribuisce - estendere l'interfaccia, processo di rilascio - per ora esiste solo in inglese, si veda English Documentation. diff --git a/docs/source/docs/It/menus.rst b/docs/source/docs/It/menus.rst new file mode 100644 index 0000000..204a1e7 --- /dev/null +++ b/docs/source/docs/It/menus.rst @@ -0,0 +1,47 @@ +Preimpostazioni e impostazioni +------------------------------ + +Menu Preimpostazioni + +* Salva preimpostazione… - le impostazioni di tutte le pagine, sotto un nome. +* Carica preimpostazione… - richiamarla. +* Elimina preimpostazione… +* Esporta… / Importa… - spostarla fra macchine come file json. +* Esporta pacchetto (+contenuti) / Importa pacchetto (+contenuti) - lo stesso, ma + con le immagini, i video e i suoni che usa, in uno zip. +* Imposta come preimpostazione di avvio… - applicarla all'avvio di FrontEngine. +* Importa contenuti Workshop… - installare preimpostazioni e pacchetti mascotte + a cui sei iscritto su Steam. + +Menu Impostazioni + +* Scorciatoie… - combinazioni globali per nascondi tutto, mostra tutto, chiudi + tutto, disattiva l'audio, opacità su e giù, pagina successiva della dashboard + e blocco. +* Tema giorno/notte programmato - chiaro di giorno, scuro di notte. +* Avvia con il sistema - aprire FrontEngine all'accesso. +* Ripristina l'ultima sessione - riaprire ciò che c'era sullo schermo. +* Carica plugin (avanzato) - i plugin sono Python e girano con gli stessi + privilegi di FrontEngine; installa solo quelli di cui ti fidi. +* Pausa intelligente… - mettere via gli overlay mentre un'applicazione è a + schermo intero, a batteria, o quando certe applicazioni sono in primo piano. +* Profili applicazione… - applicare una preimpostazione quando una data + applicazione passa in primo piano. +* Promemoria… - un messaggio ogni tot minuti, o a un'ora precisa. +* Modalità vetrina… - ruotare una lista di preimpostazioni a tempo, per una + macchina lasciata accesa come display. La finestra principale può intanto + andare nell'area di notifica - ma solo se ce n'è una da cui richiamarla. +* Telecomando… - comandare FrontEngine da un telefono sulla stessa rete e + associare un controller MIDI. Il link porta un token monouso che cambia a ogni + avvio, e solo i pulsanti della pagina possono essere attivati. È HTTP in + chiaro: sulle reti di cui non ti fidi lascialo spento. +* Privacy nella condivisione schermo… - nascondere gli overlay da una cattura + mentre è aperta un'applicazione per riunioni. Il confronto è sui titoli delle + finestre, così viene individuata anche una riunione in una scheda del browser. + Solo su Windows. +* Tempo di utilizzo… - quanto tempo passi in ogni applicazione. Resta su questa + macchina e non viene inviato altrove. +* Cronologia degli appunti… - ciò che hai copiato di recente, con ricerca e + fissaggio. Tenuta solo in memoria salvo richiesta contraria, perché negli + appunti finiscono spesso delle password. +* Esporta impostazioni… / Importa impostazioni… diff --git a/docs/source/docs/It/particle.rst b/docs/source/docs/It/particle.rst new file mode 100644 index 0000000..63d45fa --- /dev/null +++ b/docs/source/docs/It/particle.rst @@ -0,0 +1,12 @@ +Pagina Particelle +----------------- + +* Scegli immagine - il disegno di ogni particella. +* Avvia le particelle. +* Direzione - in basso, in alto, a sinistra o a destra. +* Dimensione, numero e velocità delle particelle - quanto pesa l'effetto. + Meno e più lente costa meno; il livello di qualità nel Centro di controllo + abbassa ulteriormente tutti gli overlay in una volta. +* Opacità - quanto le particelle sono trasparenti. +* Mostra su tutti gli schermi - una copia per monitor. +* Schermo di destinazione - quale schermo usare, o chiedere ogni volta. diff --git a/docs/source/docs/It/pet.rst b/docs/source/docs/It/pet.rst new file mode 100644 index 0000000..690671c --- /dev/null +++ b/docs/source/docs/It/pet.rst @@ -0,0 +1,29 @@ +Pagina Mascotte +--------------- + +Un compagno che vive sulla scrivania. + +* Scegli l'immagine della mascotte - una sola immagine. +* Scegli un pacchetto mascotte… - una cartella con le immagini walk / idle / + sleep / climb / fall / drag, così si anima. +* Scegli un suono (facoltativo) - ciò che riproduce. +* Fai comparire la mascotte - metterla sullo schermo. Premendo di nuovo ne + compare un'altra. +* Dimensione, velocità. +* Comportamento - camminare sul pavimento, vagare liberamente, o inseguire il + cursore. +* Arrampicarsi sui muri - lungo i bordi delle finestre. +* Sedersi sulle finestre - posarsi sul bordo superiore delle altre finestre. +* Fumetti - brevi battute secondo l'ora, quando le si dà da mangiare e così via. +* Leggere ad alta voce - pronunciare quelle battute. +* Giocare a rincorrersi - due o più mascotte si inseguono. +* Reagire all'audio - la mascotte si muove a tempo. Può seguire gli + **altoparlanti** o il **microfono**; in entrambi i casi legge solo un livello, + un singolo numero, e non registra mai ciò che viene detto. Solo su Windows. +* Chat IA (serve una chiave API) - parlarle. Legge la variabile d'ambiente + ANTHROPIC_API_KEY; la chiave non viene mai salvata. +* Timer di concentrazione (min) - un timer di lavoro che la mascotte tiene per + te, con le pause. + +Trascina un file sulla mascotte per darle da mangiare, oppure un'immagine o un +pacchetto per cambiarle aspetto. diff --git a/docs/source/docs/It/presentation.rst b/docs/source/docs/It/presentation.rst new file mode 100644 index 0000000..dadc3a7 --- /dev/null +++ b/docs/source/docs/It/presentation.rst @@ -0,0 +1,21 @@ +Pagina Presentazione +-------------------- + +* Annotazioni sullo schermo - disegnare sopra a ciò che è visibile. + + * Penna, evidenziatore, gomma, con colore e spessore. + * «Annulla» toglie l'ultimo tratto, «Cancella» li toglie tutti. + * Mentre il disegno è attivo questo livello prende il mouse. Tutto il resto + qui lascia passare i clic. + +* Evidenziazione del cursore - l'alone disegna un anello attorno al puntatore, + l'onda al clic mostra dove hai premuto, il riflettore oscura il resto. +* Visualizzazione dei tasti - mostra i tasti premuti, utile per registrazioni e + dimostrazioni. +* Lente - segue il cursore, da 1,5x a 6x. +* Lavagna - una tela senza fine. + + * Trascina col tasto centrale per spostarti, la rotella per ingrandire. + * I tratti sono tenuti in coordinate della tela, quindi spostarsi e + ingrandire li lascia dove devono stare. + * «Salva la lavagna» scrive un'immagine della sola area disegnata. diff --git a/docs/source/docs/It/scene.rst b/docs/source/docs/It/scene.rst new file mode 100644 index 0000000..c729ccd --- /dev/null +++ b/docs/source/docs/It/scene.rst @@ -0,0 +1,18 @@ +Pagina Scena +------------ + +.. image:: ../image/scene/scene.png + +Una scena tiene insieme più overlay e si salva in un file. + +* Aggiungi pagina web alla scena - indirizzo e opacità. +* Aggiungi video - file, opacità, velocità, volume. +* Aggiungi immagine - file e opacità. +* Aggiungi GIF - file, opacità, velocità. +* Aggiungi suono - file e volume. +* Aggiungi testo - testo, opacità, dimensione, allineamento. +* Avvia la scena - mostrare tutto ciò che è stato aggiunto. +* Esporta il file di scena. +* Carica un file di scena - riprendere una scena salvata. +* Cancella tutti gli script - ricominciare. +* Mostra su tutti gli schermi - una copia per monitor. diff --git a/docs/source/docs/It/screen_care.rst b/docs/source/docs/It/screen_care.rst new file mode 100644 index 0000000..91597ea --- /dev/null +++ b/docs/source/docs/It/screen_care.rst @@ -0,0 +1,14 @@ +Pagina Comfort visivo +--------------------- + +* Filtro schermo - un velo caldo, ambra, rosa, giallo, verde, blu o grigio sullo + schermo, con intensità regolabile. +* Righello di lettura - una fascia che segue il cursore per non perdere la riga. +* Pause per gli occhi (min / sec) - dopo tot minuti lo schermo si attenua per + tot secondi, poi te lo restituisce. +* Visione dei colori - simulare protanopia, deuteranopia, tritanopia o + acromatopsia, per controllare se un progetto resta leggibile. +* Tutti gli schermi / Schermo di destinazione - come altrove. + +Questi overlay lasciano passare i clic: tutto ciò che sta sotto continua a +funzionare. diff --git a/docs/source/docs/It/sound.rst b/docs/source/docs/It/sound.rst new file mode 100644 index 0000000..33d0b6b --- /dev/null +++ b/docs/source/docs/It/sound.rst @@ -0,0 +1,10 @@ +Pagina Musica +------------- + +.. image:: ../image/sound/sound.png + +* Scegli file wav. +* Riproduci il wav. +* Scegli file audio - qualsiasi altro formato. +* Riproduci. +* Volume. diff --git a/docs/source/docs/It/text.rst b/docs/source/docs/It/text.rst new file mode 100644 index 0000000..5f55db4 --- /dev/null +++ b/docs/source/docs/It/text.rst @@ -0,0 +1,23 @@ +Pagina Testo +------------ + +.. image:: ../image/text/text.png + +* Mostra il testo sullo schermo. +* Opacità - quanto il testo è trasparente. +* Dimensione, carattere, colore - il suo aspetto. +* Contorno - un bordo di colore contrastante, per restare leggibile su + qualunque fondo. +* Allineamento del testo - verso un angolo o al centro. +* Testo scorrevole - farlo scorrere di lato, con una sua velocità. +* Origine del testo - da dove vengono le parole. + + * Testo fisso - esattamente ciò che sta nel campo. + * Orologio / Data - un formato strftime. + * Conto alla rovescia - minuti, HH:MM, o una data completa. + * Cronometro - conta dal momento in cui parte. + * Stato del sistema - campi come {cpu} {ram} {disk} {down} {up}. + * Meteo - campi come {temperature} {description} {humidity} {wind}, per la + città indicata in «Città per il meteo». + +* Tutti gli schermi / Sotto tutte le finestre / Schermo di destinazione - come altrove. diff --git a/docs/source/docs/It/tools.rst b/docs/source/docs/It/tools.rst new file mode 100644 index 0000000..2f85e09 --- /dev/null +++ b/docs/source/docs/It/tools.rst @@ -0,0 +1,28 @@ +Pagina Strumenti +---------------- + +* Misura - clicca per misurare, il tasto destro cancella. Ciò che misuri va + dritto negli appunti. + + * Selettore di colore - il colore sotto il cursore, copiato come #rrggbb, + rgb(...), hsl(...) o come proprietà CSS personalizzata. + * Righello in pixel - la distanza fra due punti. + * Goniometro - l'angolo fra tre. + +* Cattura di un'area - traccia un'area; finisce negli appunti, e «Copia + l'ultima» ce la rimette. +* Leggi il testo - traccia un'area per copiarne il testo, tradurlo o farci una + domanda. L'area catturata viene inviata all'API di Anthropic, quindi il + consenso viene chiesto prima e viene usata la tua ANTHROPIC_API_KEY. +* Registrazione di un'area - registrare una parte dello schermo, con frequenza e + durata regolabili, volendo con la fotocamera in un angolo. +* Fotocamera virtuale - inviare un'area, overlay compresi, come webcam che Zoom, + Teams o Discord possono scegliere come sorgente video. Serve il pacchetto + facoltativo pyvirtualcam e un driver per fotocamere virtuali; se manca uno dei + due, il pulsante lo dice. +* Fotocamera - mostrare qualsiasi ingresso video, comprese le schede di + acquisizione, come cerchio, rettangolo arrotondato o rettangolo, con bordo e + specchiatura. È mostrata solo in locale e non viene registrato nulla. +* Fissa una finestra… - tenere in primo piano la finestra di un altro programma + e regolarne la trasparenza. Solo su Windows. +* Disposizione delle finestre - ricordare dove sono le finestre e rimetterle lì. diff --git a/docs/source/docs/It/ui.rst b/docs/source/docs/It/ui.rst new file mode 100644 index 0000000..9439ce7 --- /dev/null +++ b/docs/source/docs/It/ui.rst @@ -0,0 +1,41 @@ +Come si usa +----------- + +.. image:: ../image/main/FrontEngine.png + +Barra dei menu + +* Seleziona lingua - sette lingue: English, 繁體中文, 简体中文, Deutsch, + Русский, Français, Italiano. L'interfaccia cambia subito; non serve + riavviare e tutto ciò che è aperto resta aperto. +* Stile dell'interfaccia - il tema di colori, se si vuole secondo un orario + giorno/notte. +* Preimpostazioni - salvare in blocco le impostazioni di tutte le pagine e + richiamarle in seguito. +* Impostazioni - scorciatoie, tema programmato, avvio automatico, pausa + intelligente, profili applicazione, promemoria, modalità vetrina, telecomando, + privacy nella condivisione schermo, tempo di utilizzo e appunti. +* Aiuto / Documentazione - segnalazione problemi e questa documentazione. + +Schede + +* VIDEO - riprodurre un video sopra a tutto il resto. +* IMMAGINE - mostrare un'immagine, o una presentazione da una cartella. +* WEB - mostrare una pagina web, o ruotare fra più dashboard. +* GIF E WEBP - mostrare un'animazione. +* MUSICA - riprodurre un wav o un altro file audio. +* TESTO - testo, orologio, conto alla rovescia, stato del sistema o meteo. +* SCENA - combinare più elementi fra i precedenti e salvarli in un file. +* PARTICELLE - un effetto a particelle sopra la scrivania. +* MASCOTTE - un compagno che cammina, si arrampica e reagisce. +* COMFORT VISIVO - filtro schermo, righello di lettura, pause, visione dei colori. +* PRESENTAZIONE - annotazioni, evidenziazione del cursore, tasti, lente, lavagna. +* SFONDO - uno sfondo animato sotto ogni finestra. +* CONCENTRAZIONE - oscurare lo sfondo o coprire una distrazione. +* WIDGET - spettro audio, monitor di sistema, in riproduzione, foglietti. +* STRUMENTI - misurare, catturare, leggere testo, registrare, fotocamera + virtuale, fotocamera, fissare finestre. +* CENTRO DI CONTROLLO - comandare tutti gli overlay insieme. + +A parte la mascotte e il livello di disegno, tutti gli overlay lasciano passare +i clic: ciò che sta sotto continua a funzionare. diff --git a/docs/source/docs/It/video.rst b/docs/source/docs/It/video.rst new file mode 100644 index 0000000..a4952e0 --- /dev/null +++ b/docs/source/docs/It/video.rst @@ -0,0 +1,15 @@ +Pagina Video +------------ + +.. image:: ../image/video/video.png + +* Scegli file video - il file da riprodurre. +* Avvia il video - mostrarlo. +* Opacità - quanto il video è trasparente. +* Velocità di riproduzione. +* Volume. +* Schermo intero - allargare a tutto lo schermo. +* Mostra su tutti gli schermi - una copia per monitor. +* Mostra sotto tutte le finestre - collocarlo sotto le altre finestre. +* Schermo di destinazione - quale schermo usare, o chiedere ogni volta. +* Recenti - i file già riprodotti. diff --git a/docs/source/docs/It/wallpaper.rst b/docs/source/docs/It/wallpaper.rst new file mode 100644 index 0000000..80bdea6 --- /dev/null +++ b/docs/source/docs/It/wallpaper.rst @@ -0,0 +1,15 @@ +Pagina Sfondo +------------- + +Uno sfondo sta sotto ogni finestra, quindi non è mai d'intralcio. + +* Schermo - ogni schermo può usare la propria cartella. +* Scegli cartella… - dove stanno le immagini o i video. +* Cambia ogni - quanto resta ciascuno, da 30 secondi a un'ora. +* Casuale - ordine mescolato. +* Includi le sottocartelle. +* Reagisci all'audio - lo sfondo risponde a ciò che riproducono gli + altoparlanti. Ne legge un livello, non il suono stesso. Solo su Windows. +* Ore di quiete - fra i due orari indicati passa alla cartella «quiete», per + qualcosa di più sobrio mentre si lavora. +* Avvia lo sfondo / Sfondo successivo. diff --git a/docs/source/docs/It/web.rst b/docs/source/docs/It/web.rst new file mode 100644 index 0000000..521cc12 --- /dev/null +++ b/docs/source/docs/It/web.rst @@ -0,0 +1,18 @@ +Pagina Web +---------- + +.. image:: ../image/web/web.png + +* Apri pagina con l'indirizzo - mostrare l'indirizzo scritto nel campo. +* Apri file locale - leggere il campo come percorso a un html locale. +* Consenti l'input - lasciare che la pagina riceva clic e tastiera. +* Opacità - quanto la pagina è trasparente. +* Zoom - dal 50% al 200%. +* Aggiornamento automatico - ricaricare da ogni 30 secondi a ogni 15 minuti. +* URL della dashboard - un indirizzo per riga; le righe che iniziano con # + vengono ignorate. + + * Avvia la dashboard - ruotare fra quegli indirizzi. + * Pagina successiva - passare subito alla prossima. + +* Tutti gli schermi / Sotto tutte le finestre / Schermo di destinazione - come altrove. diff --git a/docs/source/docs/It/widgets.rst b/docs/source/docs/It/widgets.rst new file mode 100644 index 0000000..b4ca8df --- /dev/null +++ b/docs/source/docs/It/widgets.rst @@ -0,0 +1,12 @@ +Pagina Widget +------------- + +* Spettro audio - barre o un anello che si muovono con ciò che riproducono gli + altoparlanti, con numero di bande regolabile. Questo cattura davvero l'audio, + ma solo in memoria per calcolarne le frequenze; nulla viene registrato o + inviato, e la cattura finisce insieme allo spettro. Solo su Windows. +* Monitor di sistema - processore, memoria, disco e rete in un piccolo pannello + sempre visibile. +* Mostra in riproduzione - il brano a cui è arrivato il tuo lettore. +* Foglietto adesivo - «Nuova nota» ne appiccica uno sulla scrivania, «Chiudi le + note» li toglie. «Riapri le mie note all'avvio» li riporta la volta dopo. diff --git a/docs/source/docs/Ru/control_center.rst b/docs/source/docs/Ru/control_center.rst new file mode 100644 index 0000000..5728e34 --- /dev/null +++ b/docs/source/docs/Ru/control_center.rst @@ -0,0 +1,28 @@ +Центр управления +---------------- + +.. image:: ../image/control_center/control_center.png + +Одна страница, дотягивающаяся до каждого слоя, включая открытые другими +вкладками. + +Закрытие + +* Закрыть все видео / изображения / GIF / страницы / звуки / тексты - только + этот вид. +* Закрыть всё - каждый слой на экране, какой бы вкладкой он ни был открыт. +* Очистить журнал - опустошить область сообщений справа. + +Всё сразу + +* Скрыть всё / Показать всё - ненадолго убрать и вернуть. +* Выключить весь звук. +* Заблокировать / разблокировать слои - разблокированные можно перетаскивать + мышью, и они запоминают, где их оставили; заблокированные пропускают щелчки. +* Хромакей - залить фон одним цветом для кеинга в OBS и подобном. +* Сбросить положение слоёв - вернуть всё на исходные места. +* Энергосбережение - снизить частоту обновления и разрешение, когда важна батарея. +* Качество - высокое, сбалансированное или экономное: то же самое, но тоньше. +* Скрыть от захвата - слои остаются на вашем экране, но не попадают в то, что + записывает демонстрация экрана. Только в Windows. Заслонка со страницы + «Фокус» остаётся видимой - закрывать что-то и есть её назначение. diff --git a/docs/source/docs/Ru/focus.rst b/docs/source/docs/Ru/focus.rst new file mode 100644 index 0000000..acdffe8 --- /dev/null +++ b/docs/source/docs/Ru/focus.rst @@ -0,0 +1,12 @@ +Фокус +----- + +* Затемнять фоновые окна - приглушить всё, кроме используемого окна, с + регулируемой силой. +* Закрыть отвлекающее - спрятать часть экрана: нижнюю полосу с панелью задач, + правый нижний угол, верхнюю полосу, любой из боковых краёв или весь экран. +* Целевой экран - какой экран использовать или спрашивать каждый раз. + +Оба пропускают щелчки насквозь: закрытое продолжает работать, просто перестаёт +отвлекать. Заслонка к тому же остаётся видимой при показе экрана - закрывать +что-то и есть её единственное назначение. diff --git a/docs/source/docs/Ru/gif_and_webp.rst b/docs/source/docs/Ru/gif_and_webp.rst new file mode 100644 index 0000000..037d036 --- /dev/null +++ b/docs/source/docs/Ru/gif_and_webp.rst @@ -0,0 +1,14 @@ +GIF и WEBP +---------- + +.. image:: ../image/gif_and_webp/gif_and_webp.png + +* Выбрать файл GIF или WEBP - какую анимацию показать. +* Воспроизвести GIF или WEBP - показать её. +* Непрозрачность - насколько она просвечивает. +* Скорость - как быстро она идёт. +* Полный экран - растянуть на весь экран. +* Показывать на всех экранах - по копии на монитор. +* Показывать под всеми окнами - разместить ниже прочих окон. +* Целевой экран - какой экран использовать или спрашивать каждый раз. +* Недавние - ранее показанные анимации. diff --git a/docs/source/docs/Ru/image.rst b/docs/source/docs/Ru/image.rst new file mode 100644 index 0000000..acb750c --- /dev/null +++ b/docs/source/docs/Ru/image.rst @@ -0,0 +1,20 @@ +Изображение +----------- + +.. image:: ../image/image_page/image_page.png + +* Выбрать изображение - какую картинку показать. +* Показать изображение. +* Непрозрачность - насколько картинка просвечивает. +* Полный экран - растянуть на весь экран. +* Показывать на всех экранах - по копии на монитор. +* Показывать под всеми окнами - разместить ниже прочих окон. +* Слайд-шоу - показывать все картинки из папки по очереди. + + * Выбрать папку - где лежат картинки. + * Интервал - сколько секунд на картинку. + * В случайном порядке. + * Включая вложенные папки. + +* Целевой экран - какой экран использовать или спрашивать каждый раз. +* Недавние - ранее показанные картинки. diff --git a/docs/source/docs/Ru/menus.rst b/docs/source/docs/Ru/menus.rst new file mode 100644 index 0000000..b2d9eb4 --- /dev/null +++ b/docs/source/docs/Ru/menus.rst @@ -0,0 +1,46 @@ +Пресеты и настройки +------------------- + +Меню «Пресеты» + +* Сохранить пресет… - настройки всех вкладок целиком, под именем. +* Загрузить пресет… - вернуть. +* Удалить пресет… +* Экспортировать… / Импортировать… - переносить между машинами файлом json. +* Экспорт пакета (+файлы) / Импорт пакета (+файлы) - то же, но вместе с + картинками, видео и звуками, которые он использует, архивом zip. +* Сделать пресетом при запуске… - применять при старте FrontEngine. +* Импортировать содержимое Мастерской… - установить пресеты и наборы питомца, + на которые вы подписаны в Steam. + +Меню «Настройки» + +* Горячие клавиши… - глобальные сочетания для «скрыть всё», «показать всё», + «закрыть всё», «выключить звук», непрозрачности вверх и вниз, следующей + страницы панели и блокировки. +* Тема по расписанию день/ночь - днём светлая, ночью тёмная. +* Запускать вместе с системой - открывать FrontEngine при входе. +* Восстанавливать прошлый сеанс - открывать то, что было на экране в прошлый раз. +* Загружать плагины (для опытных) - плагины это Python и работают с теми же + правами, что и FrontEngine; ставьте только те, которым доверяете. +* Умная пауза… - убирать слои, пока работает полноэкранное приложение, при + питании от батареи или когда активны названные приложения. +* Профили приложений… - применять пресет, когда указанное приложение выходит + на передний план. +* Напоминания… - сообщение каждые столько-то минут или в заданное время. +* Режим витрины… - перебирать список пресетов по таймеру, для компьютера, + оставленного работать как экран. Главное окно при этом может уйти в трей - + но только если есть трей, из которого его можно вернуть. +* Пульт управления… - управлять FrontEngine с телефона в той же сети и + привязать MIDI-контроллер. Ссылка несёт одноразовый токен, который меняется + при каждом запуске, и сработать могут только кнопки на странице. Это обычный + HTTP, поэтому в сетях, которым вы не доверяете, оставляйте выключенным. +* Приватность при показе экрана… - скрывать слои от захвата, пока открыто + приложение для встреч. Сравнение идёт по заголовкам окон, поэтому встреча во + вкладке браузера тоже распознаётся. Только в Windows. +* Экранное время… - сколько времени уходит на каждое приложение. Хранится + только на этом компьютере и никуда не отправляется. +* История буфера обмена… - что вы копировали недавно, с поиском и закреплением. + Хранится только в памяти, если вы не попросите иначе, ведь в буфере часто + оказываются пароли. +* Экспорт настроек… / Импорт настроек… diff --git a/docs/source/docs/Ru/particle.rst b/docs/source/docs/Ru/particle.rst new file mode 100644 index 0000000..0dde1ae --- /dev/null +++ b/docs/source/docs/Ru/particle.rst @@ -0,0 +1,12 @@ +Частицы +------- + +* Выбрать изображение - из чего рисуется каждая частица. +* Запустить частицы. +* Направление - вниз, вверх, влево или вправо. +* Размер, количество и скорость частиц - насколько эффект тяжёл. + Меньше и медленнее - дешевле; уровень качества в Центре управления снижает + нагрузку сразу для всех слоёв. +* Непрозрачность - насколько частицы просвечивают. +* Показывать на всех экранах - по копии на монитор. +* Целевой экран - какой экран использовать или спрашивать каждый раз. diff --git a/docs/source/docs/Ru/pet.rst b/docs/source/docs/Ru/pet.rst new file mode 100644 index 0000000..a7d3435 --- /dev/null +++ b/docs/source/docs/Ru/pet.rst @@ -0,0 +1,26 @@ +Питомец +------- + +Спутник, который живёт на рабочем столе. + +* Выбрать изображение питомца - одна картинка. +* Выбрать набор питомца… - папка с кадрами walk / idle / sleep / climb / fall / + drag, чтобы он двигался. +* Выбрать звук (необязательно) - что он проигрывает. +* Призвать питомца - поместить на экран. Нажмите ещё раз - появится второй. +* Размер, скорость. +* Поведение - ходить по полу, свободно бродить или бежать за курсором. +* Лазать по стенам - подниматься по краям окон. +* Сидеть на окнах - устраиваться на верхней кромке чужих окон. +* Реплики в облачках - короткие фразы по времени суток, при кормлении и так далее. +* Проговаривать вслух - озвучивать эти фразы. +* Играть в догонялки - два и более питомца гоняются друг за другом. +* Реагировать на звук - питомец движется в такт. Он может следовать за + **динамиками** или за **микрофоном**; в обоих случаях читается уровень, + одно число, и никогда не записывается сказанное. Только в Windows. +* Чат с ИИ (нужен ключ API) - поговорить с ним. Читается переменная окружения + ANTHROPIC_API_KEY, ключ нигде не сохраняется. +* Таймер фокуса (мин) - рабочий таймер, который питомец ведёт за вас, с перерывами. + +Перетащите файл на питомца, чтобы покормить его, или картинку либо набор +питомца, чтобы сменить облик. diff --git a/docs/source/docs/Ru/presentation.rst b/docs/source/docs/Ru/presentation.rst new file mode 100644 index 0000000..4abe6e5 --- /dev/null +++ b/docs/source/docs/Ru/presentation.rst @@ -0,0 +1,20 @@ +Презентация +----------- + +* Рисование по экрану - рисовать поверх всего, что видно. + + * Перо, маркер, ластик, с цветом и толщиной. + * «Отменить» убирает последний штрих, «Очистить» - все. + * Пока рисование включено, этот слой занимает мышь. Всё остальное здесь + пропускает щелчки насквозь. + +* Подсветка курсора - «Ореол» рисует кольцо вокруг указателя, «Круги от щелчка» + показывают, куда вы нажали, «Прожектор» затемняет всё остальное. +* Показ нажатий - показывает нажатые клавиши, удобно для записей и демонстраций. +* Лупа - следует за курсором, от 1,5x до 6x. +* Доска - бесконечное полотно. + + * Перетаскивание средней кнопкой сдвигает, колесо масштабирует. + * Штрихи хранятся в координатах полотна, поэтому сдвиг и масштаб оставляют + их там, где им положено. + * «Сохранить доску» пишет изображение именно того участка, где вы рисовали. diff --git a/docs/source/docs/Ru/ru_index.rst b/docs/source/docs/Ru/ru_index.rst new file mode 100644 index 0000000..1b4503d --- /dev/null +++ b/docs/source/docs/Ru/ru_index.rst @@ -0,0 +1,28 @@ +Документация FrontEngine на русском +----------------------------------- + +.. toctree:: + :maxdepth: 4 + + ui.rst + video.rst + image.rst + web.rst + gif_and_webp.rst + sound.rst + text.rst + scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst + control_center.rst + menus.rst + +---- + +Документация для участников проекта - расширение интерфейса, процесс выпуска - пока есть только на английском, см. English Documentation. diff --git a/docs/source/docs/Ru/scene.rst b/docs/source/docs/Ru/scene.rst new file mode 100644 index 0000000..3c8407b --- /dev/null +++ b/docs/source/docs/Ru/scene.rst @@ -0,0 +1,18 @@ +Сцена +----- + +.. image:: ../image/scene/scene.png + +Сцена держит сразу несколько слоёв и сохраняется в файл. + +* Добавить веб-страницу - адрес и непрозрачность. +* Добавить видео - файл, непрозрачность, скорость, громкость. +* Добавить изображение - файл и непрозрачность. +* Добавить GIF - файл, непрозрачность, скорость. +* Добавить звук - файл и громкость. +* Добавить текст - текст, непрозрачность, размер шрифта, выравнивание. +* Запустить сцену - показать всё добавленное. +* Сохранить файл сцены. +* Загрузить файл сцены - вернуть сохранённую сцену. +* Очистить все сценарии - начать заново. +* Показывать на всех экранах - по копии на монитор. diff --git a/docs/source/docs/Ru/screen_care.rst b/docs/source/docs/Ru/screen_care.rst new file mode 100644 index 0000000..f22eac9 --- /dev/null +++ b/docs/source/docs/Ru/screen_care.rst @@ -0,0 +1,13 @@ +Забота о глазах +--------------- + +* Фильтр экрана - тёплая, янтарная, розовая, жёлтая, зелёная, синяя или серая + пелена поверх изображения, с регулируемой силой. +* Линейка для чтения - полоса, следующая за курсором, чтобы не терять строку. +* Перерывы для глаз (мин / с) - через столько-то минут экран гаснет на + столько-то секунд и возвращается. +* Цветовое зрение - смоделировать протанопию, дейтеранопию, тританопию или + ахроматопсию и проверить, читается ли ваш макет. +* Показывать на всех экранах / Целевой экран - как и везде. + +Эти слои пропускают щелчки насквозь, всё под ними продолжает работать. diff --git a/docs/source/docs/Ru/sound.rst b/docs/source/docs/Ru/sound.rst new file mode 100644 index 0000000..7a3bd2e --- /dev/null +++ b/docs/source/docs/Ru/sound.rst @@ -0,0 +1,10 @@ +Музыка +------ + +.. image:: ../image/sound/sound.png + +* Выбрать wav-файл. +* Воспроизвести wav. +* Выбрать звуковой файл - любой другой формат. +* Воспроизвести. +* Громкость. diff --git a/docs/source/docs/Ru/text.rst b/docs/source/docs/Ru/text.rst new file mode 100644 index 0000000..f758435 --- /dev/null +++ b/docs/source/docs/Ru/text.rst @@ -0,0 +1,22 @@ +Текст +----- + +.. image:: ../image/text/text.png + +* Показать текст на экране. +* Непрозрачность - насколько текст просвечивает. +* Размер шрифта, шрифт, цвет - как он выглядит. +* Обводка - контрастный контур, чтобы текст читался на любом фоне. +* Выравнивание текста - к какому углу или по центру. +* Бегущая строка - пустить текст вбок, со своей скоростью. +* Источник текста - откуда берутся слова. + + * Постоянный текст - ровно то, что в поле. + * Часы / Дата - формат strftime. + * Обратный отсчёт - минуты, ЧЧ:ММ или полная дата. + * Секундомер - считает с момента запуска. + * Состояние системы - поля вида {cpu} {ram} {disk} {down} {up}. + * Погода - поля вида {temperature} {description} {humidity} {wind}, для + города, указанного в «Город для погоды». + +* Показывать на всех экранах / под всеми окнами / Целевой экран - как и везде. diff --git a/docs/source/docs/Ru/tools.rst b/docs/source/docs/Ru/tools.rst new file mode 100644 index 0000000..f580fc7 --- /dev/null +++ b/docs/source/docs/Ru/tools.rst @@ -0,0 +1,28 @@ +Инструменты +----------- + +* Измерение - щёлкните, чтобы измерить, правая кнопка очищает. Измеренное сразу + попадает в буфер обмена. + + * Пипетка - цвет под курсором, копируется как #rrggbb, rgb(...), hsl(...) + или как CSS-переменная. + * Линейка в пикселях - расстояние между двумя точками. + * Транспортир - угол между тремя. + +* Снимок области - выделите участок; он попадает в буфер обмена, а «Копировать + последний» кладёт его туда снова. +* Чтение текста - выделите участок, чтобы скопировать текст из него, перевести + его или задать по нему вопрос. Снятая область уходит в API Anthropic, поэтому + сначала спрашивается согласие; используется ваш собственный ANTHROPIC_API_KEY. +* Запись области - записать часть экрана, с настраиваемой частотой кадров и + длительностью, при желании с камерой в углу. +* Виртуальная камера - передать область вместе со слоями как веб-камеру, + которую Zoom, Teams или Discord смогут выбрать источником видео. Нужен + необязательный пакет pyvirtualcam и драйвер виртуальной камеры; без любого из + них кнопка так и скажет. +* Камера - показать любой видеовход, включая карты захвата, кругом, + скруглённым прямоугольником или прямоугольником, с рамкой и зеркалом. + Показывается только локально, ничего не записывается. +* Закрепить окно… - держать окно другой программы поверх остальных и менять его + прозрачность. Только в Windows. +* Расположение окон - запомнить, где стоят окна, и вернуть их позже. diff --git a/docs/source/docs/Ru/ui.rst b/docs/source/docs/Ru/ui.rst new file mode 100644 index 0000000..150f7fe --- /dev/null +++ b/docs/source/docs/Ru/ui.rst @@ -0,0 +1,39 @@ +Как пользоваться +---------------- + +.. image:: ../image/main/FrontEngine.png + +Строка меню + +* Выбор языка - семь языков: English, 繁體中文, 简体中文, Deutsch, Русский, + Français, Italiano. Интерфейс меняется сразу; перезапуск не нужен, и всё + открытое остаётся открытым. +* Стиль интерфейса - цветовая тема, при желании по расписанию день/ночь. +* Пресеты - сохранить настройки всех вкладок целиком и вернуть их позже. +* Настройки - горячие клавиши, тема по расписанию, автозапуск, умная пауза, + профили приложений, напоминания, режим витрины, пульт управления, + приватность при показе экрана, экранное время и буфер обмена. +* Помощь / Документация - трекер задач и эта документация. + +Вкладки + +* ВИДЕО - воспроизвести видео поверх всего остального. +* ИЗОБРАЖЕНИЕ - показать картинку или слайд-шоу из папки. +* ВЕБ - показать страницу или перебирать несколько панелей. +* GIF И WEBP - показать анимацию. +* МУЗЫКА - воспроизвести wav или другой звуковой файл. +* ТЕКСТ - текст, часы, обратный отсчёт, состояние системы или погода. +* СЦЕНА - объединить несколько из перечисленного и сохранить в файл. +* ЧАСТИЦЫ - эффект частиц поверх рабочего стола. +* ПИТОМЕЦ - спутник, который ходит, лазает и реагирует на вас. +* ЗАБОТА О ГЛАЗАХ - фильтр экрана, линейка для чтения, перерывы, цветовое зрение. +* ПРЕЗЕНТАЦИЯ - рисование, подсветка курсора, показ нажатий, лупа, доска. +* ОБОИ - живые обои под всеми окнами. +* ФОКУС - затемнить фон или закрыть отвлекающее. +* ВИДЖЕТЫ - спектр звука, монитор системы, что играет, заметки. +* ИНСТРУМЕНТЫ - измерение, снимок, чтение текста, запись, виртуальная камера, + камера, закрепление окон. +* ЦЕНТР УПРАВЛЕНИЯ - управлять всеми слоями сразу. + +Кроме питомца и слоя рисования все слои пропускают щелчки насквозь, поэтому +то, что под ними, продолжает работать. diff --git a/docs/source/docs/Ru/video.rst b/docs/source/docs/Ru/video.rst new file mode 100644 index 0000000..e34c482 --- /dev/null +++ b/docs/source/docs/Ru/video.rst @@ -0,0 +1,15 @@ +Видео +----- + +.. image:: ../image/video/video.png + +* Выбрать видеофайл - какой файл проигрывать. +* Начать воспроизведение - показать его. +* Непрозрачность - насколько видео просвечивает. +* Скорость воспроизведения. +* Громкость. +* Полный экран - растянуть на весь экран. +* Показывать на всех экранах - по копии на монитор. +* Показывать под всеми окнами - разместить ниже прочих окон. +* Целевой экран - какой экран использовать или спрашивать каждый раз. +* Недавние - файлы, которые вы уже проигрывали. diff --git a/docs/source/docs/Ru/wallpaper.rst b/docs/source/docs/Ru/wallpaper.rst new file mode 100644 index 0000000..3963a8e --- /dev/null +++ b/docs/source/docs/Ru/wallpaper.rst @@ -0,0 +1,15 @@ +Обои +---- + +Обои лежат ниже всех окон, поэтому никогда не мешают. + +* Экран - у каждого экрана может быть своя папка. +* Выбрать папку… - где лежат картинки или видео. +* Менять каждые - сколько держится каждая, от 30 секунд до часа. +* В случайном порядке. +* Включая вложенные папки. +* Реагировать на звук - обои отзываются на то, что играют динамики. Читается + уровень, а не сам звук. Только в Windows. +* Тихие часы - между двумя указанными временами брать «тихую» папку, чтобы во + время работы было спокойнее. +* Запустить обои / Следующие обои. diff --git a/docs/source/docs/Ru/web.rst b/docs/source/docs/Ru/web.rst new file mode 100644 index 0000000..95b2d53 --- /dev/null +++ b/docs/source/docs/Ru/web.rst @@ -0,0 +1,17 @@ +Веб +--- + +.. image:: ../image/web/web.png + +* Открыть страницу по адресу - показать адрес из поля. +* Открыть локальный файл - считать поле путём к локальному html-файлу. +* Разрешить ввод - дать странице принимать щелчки и клавиатуру. +* Непрозрачность - насколько страница просвечивает. +* Масштаб - от 50% до 200%. +* Автообновление - перезагружать от раза в 30 секунд до раза в 15 минут. +* Адреса панели - по одному адресу на строку; строки с # пропускаются. + + * Запустить панель - перебирать эти адреса. + * Следующая страница - переключиться сейчас. + +* Показывать на всех экранах / под всеми окнами / Целевой экран - как и везде. diff --git a/docs/source/docs/Ru/widgets.rst b/docs/source/docs/Ru/widgets.rst new file mode 100644 index 0000000..592d9f9 --- /dev/null +++ b/docs/source/docs/Ru/widgets.rst @@ -0,0 +1,13 @@ +Виджеты +------- + +* Спектр звука - столбцы или кольцо, которые движутся под то, что играют + динамики, с настраиваемым числом полос. Здесь звук действительно + захватывается, но только в памяти, чтобы вычислить частоты; ничего не + записывается и не отправляется, а захват прекращается вместе со спектром. + Только в Windows. +* Монитор системы - процессор, память, диск и сеть небольшой всегда видимой + панелью. +* Показать, что играет - трек, на котором сейчас ваш проигрыватель. +* Заметка - «Новая заметка» кладёт листок на рабочий стол, «Закрыть заметки» + убирает их. «Открывать мои заметки при запуске» вернёт их в следующий раз. diff --git a/docs/source/docs/Zh/control_center.rst b/docs/source/docs/Zh/control_center.rst index 2ade52d..668dca2 100644 --- a/docs/source/docs/Zh/control_center.rst +++ b/docs/source/docs/Zh/control_center.rst @@ -1,14 +1,25 @@ 控制中心頁面 ----- +------------ .. image:: ../image/control_center/control_center.png -* 控制面板有一個區域用於顯示錯誤訊息並控制其他實例。 - * 「關閉所有影片」按鈕將關閉所有影片實例。 - * 「關閉所有圖片」按鈕將關閉所有圖片實例。 - * 「關閉所有 GIF」按鈕將關閉所有 GIF 實例。 - * 「關閉所有網頁」按鈕將關閉所有網頁。 - * 「關閉所有音效」按鈕將關閉所有正在播放的音效實例。 - * 「清除所有文字」將清除屏幕上的所有文字。 - * 「清除日誌」將清除錯誤訊息區域。 - * 「關閉所有」將關閉所有實例。 \ No newline at end of file +這一頁碰得到所有覆蓋層，包含其他分頁開出來的那些。 + +關閉 + +* 關閉所有影片／圖片／GIF／網頁／音效／文字 - 只關那一類。 +* 關閉所有 - 關掉畫面上每一個覆蓋層，不管是哪一頁開的。 +* 清除日誌 - 清空右側的訊息區。 + +整批操作 + +* 全部隱藏 / 全部顯示 - 暫時收起來，再叫回來。 +* 全部靜音 - 讓所有會出聲的東西安靜。 +* 鎖定 / 解除鎖定覆蓋層 - 解除鎖定後可以用滑鼠把覆蓋層拖到想要的位置， + 放開時位置會被記住；鎖定時則讓點擊穿透。 +* 去背色 - 把背景塗成單一顏色，方便在 OBS 之類的軟體裡去背。 +* 重設覆蓋層位置 - 全部擺回一開始的地方。 +* 省電模式 - 在意電池時降低更新率與算圖解析度。 +* 畫質 - 高、平衡、省電，是上面那件事更細的版本。 +* 從畫面擷取中隱藏 - 覆蓋層留在你自己的螢幕上，但不會出現在螢幕分享的結果裡。 + 僅 Windows 有效。專注頁的遮蔽層會保持可見——遮住東西正是它唯一的用途。 diff --git a/docs/source/docs/Zh/focus.rst b/docs/source/docs/Zh/focus.rst new file mode 100644 index 0000000..506a876 --- /dev/null +++ b/docs/source/docs/Zh/focus.rst @@ -0,0 +1,10 @@ +專注頁面 +-------- + +* 調暗背景視窗 - 把正在使用的視窗以外的地方壓暗，強度可調。 +* 遮住干擾 - 遮掉畫面的某一塊：工作列所在的底部橫條、右下角、頂部橫條、 + 左右任一側邊，或整個螢幕。 +* 目標螢幕 - 要用哪個螢幕，或每次詢問。 + +兩者都讓點擊穿透：被遮住的東西照常能用，只是不再搶你的注意力。 +遮蔽層在螢幕分享時也會保持可見——遮住東西正是它唯一的用途。 diff --git a/docs/source/docs/Zh/gif_and_webp.rst b/docs/source/docs/Zh/gif_and_webp.rst index cf4f439..189ba59 100644 --- a/docs/source/docs/Zh/gif_and_webp.rst +++ b/docs/source/docs/Zh/gif_and_webp.rst @@ -1,13 +1,14 @@ -GIF & WEBP 頁面 ----- +GIF 和 WEBP 頁面 +---------------- .. image:: ../image/gif_and_webp/gif_and_webp.png -* GIF 和 webp 選項卡具有以下選項： - * 不透明度：GIF 或 webp 的不透明度。 - * 速度：GIF 播放速率的百分比。 - * 在所有螢幕上顯示（在所有屏幕上顯示圖片）。 - * 在所有視窗底部顯示（圖片將在所有視窗底部隱藏）。 -* 按鈕： - * 選擇 GIF 或 webp 檔案（選擇 .gif 或 .webp 文件）。 - * 開始播放 GIF 或 web（讀取檔案並開始播放 GIF 或 webp）。 \ No newline at end of file +* 選擇 GIF 或 WEBP 檔 - 挑要播放的動畫。 +* 開始播放 GIF 或 WEBP - 顯示它。 +* 不透明度 - 動畫有多透明。 +* 速度 - 播放的快慢。 +* 全螢幕 - 拉伸到整個螢幕。 +* 顯示在所有螢幕 - 每個螢幕各一份。 +* 顯示在所有視窗底下 - 放到其他視窗之下。 +* 目標螢幕 - 要用哪個螢幕，或每次詢問。 +* 最近使用 - 之前播過的動畫。 diff --git a/docs/source/docs/Zh/how_to_extend_ui.rst b/docs/source/docs/Zh/how_to_extend_ui.rst index 027f109..aeb8e7d 100644 --- a/docs/source/docs/Zh/how_to_extend_ui.rst +++ b/docs/source/docs/Zh/how_to_extend_ui.rst @@ -1,5 +1,5 @@ 怎麼擴充 FrontEngine UI ----- +----------------------- .. image:: ../image/main/FrontEngine.png diff --git a/docs/source/docs/Zh/image.rst b/docs/source/docs/Zh/image.rst index 2496ad5..fb21aef 100644 --- a/docs/source/docs/Zh/image.rst +++ b/docs/source/docs/Zh/image.rst @@ -1,12 +1,20 @@ 圖片頁面 ----- +-------- .. image:: ../image/image_page/image_page.png -* 圖片選項卡具有以下選項: - * 不透明度：圖片的不透明度。 - * 在所有螢幕上顯示（在所有屏幕上顯示圖片）。 - * 在所有視窗底部顯示（圖片將在所有視窗底部隱藏）。 -* 按鈕 - * 選擇圖片 (選擇你想播放的圖片檔案 .jpg .png . webp) - * 開始播放圖片 (讀取設定並開始播放) \ No newline at end of file +* 選擇圖片 - 挑要顯示的圖片。 +* 開始顯示圖片 - 顯示它。 +* 不透明度 - 圖片有多透明。 +* 全螢幕 - 拉伸到整個螢幕。 +* 顯示在所有螢幕 - 每個螢幕各一份。 +* 顯示在所有視窗底下 - 放到其他視窗之下。 +* 幻燈片 - 依序顯示資料夾裡的每一張圖。 + + * 選擇資料夾 - 圖片放在哪裡。 + * 間隔 - 每張停留幾秒。 + * 隨機播放 - 打亂順序。 + * 包含子資料夾 - 連巢狀資料夾一起找。 + +* 目標螢幕 - 要用哪個螢幕，或每次詢問。 +* 最近使用 - 之前顯示過的圖片。 diff --git a/docs/source/docs/Zh/menus.rst b/docs/source/docs/Zh/menus.rst new file mode 100644 index 0000000..abb8293 --- /dev/null +++ b/docs/source/docs/Zh/menus.rst @@ -0,0 +1,37 @@ +預設集與設定 +------------ + +預設集選單 + +* 儲存預設集… - 把各分頁目前的設定整組記下來，取個名字。 +* 載入預設集… - 叫回來。 +* 刪除預設集… +* 匯出預設集… / 匯入預設集… - 以 json 檔在不同機器之間搬移。 +* 匯出打包（含素材） / 匯入打包（含素材） - 同上，但連它用到的圖片、影片、 + 音效一起打包成 zip。 +* 設為啟動預設集… - FrontEngine 啟動時自動套用。 +* 匯入創意工坊內容… - 安裝你在 Steam 上訂閱的預設集與寵物包。 + +設定選單 + +* 快速鍵… - 全部隱藏、全部顯示、全部關閉、全部靜音、提高／降低不透明度、 + 下一頁儀表板與鎖定的全域快速鍵。 +* 日夜主題自動切換 - 白天亮色、晚上暗色。 +* 開機時啟動 - 登入時自動開啟 FrontEngine。 +* 還原上次的工作階段 - 重新打開上次畫面上的東西。 +* 載入外掛（進階） - 外掛是 Python 程式，與 FrontEngine 同權限執行， + 只安裝你信任的。 +* 智慧暫停… - 有全螢幕程式在跑、使用電池，或指定程式取得焦點時，把覆蓋層收起來。 +* 應用情境… - 某個程式切到前景時自動套用指定的預設集。 +* 提醒… - 每隔幾分鐘，或在固定時刻提醒你一句話。 +* 看板模式… - 依序輪播一組預設集，適合把機器擺著當展示螢幕。 + 執行時主視窗可以收進系統匣——但只有在系統匣真的能把它叫回來時才會收。 +* 手機遙控… - 用同一個網路上的手機控制 FrontEngine，也可以綁 MIDI 控制器。 + 連結帶的是一次性權杖，每次啟動都會更換，而且只有頁面上那些按鈕能被觸發。 + 它走的是純 HTTP，在你不信任的網路上請保持關閉。 +* 螢幕分享隱私… - 會議程式開著時，把覆蓋層從畫面擷取中隱藏。 + 比對的是視窗標題，所以在瀏覽器分頁裡開的會議也抓得到。僅 Windows 有效。 +* 螢幕使用時間… - 你在每個程式上花了多久。只存在這台機器上，不會送到任何地方。 +* 剪貼簿歷史… - 最近複製過的內容，可搜尋、可釘選。 + 除非你要求保留，否則只存在記憶體裡——因為剪貼簿常常有密碼。 +* 匯出設定… / 匯入設定… diff --git a/docs/source/docs/Zh/particle.rst b/docs/source/docs/Zh/particle.rst new file mode 100644 index 0000000..019e08e --- /dev/null +++ b/docs/source/docs/Zh/particle.rst @@ -0,0 +1,11 @@ +粒子頁面 +-------- + +* 選擇圖片 - 每個粒子用哪張圖畫。 +* 開始播放粒子 - 開始效果。 +* 選擇粒子方向 - 向下、向上、向左或向右。 +* 粒子大小、粒子數量、粒子速度 - 決定這個效果有多吃資源。 + 少一點、慢一點就省一些；控制中心的畫質檔位可以一次把所有覆蓋層再降一級。 +* 不透明度 - 粒子有多透明。 +* 顯示在所有螢幕 - 每個螢幕各一份。 +* 目標螢幕 - 要用哪個螢幕，或每次詢問。 diff --git a/docs/source/docs/Zh/pet.rst b/docs/source/docs/Zh/pet.rst new file mode 100644 index 0000000..fba355d --- /dev/null +++ b/docs/source/docs/Zh/pet.rst @@ -0,0 +1,24 @@ +寵物頁面 +-------- + +一隻住在桌面上的夥伴。 + +* 選擇寵物圖檔 - 單張圖片。 +* 選擇寵物包… - 一個資料夾，裡面有 walk / idle / sleep / climb / fall / drag + 這些動作的圖，寵物就會有動畫。 +* 選擇音效（可不選） - 它會播放的聲音。 +* 召喚寵物 - 放到畫面上。再按一次會多一隻。 +* 大小、速度 - 多大、多快。 +* 行為 - 在地面走動、自由漫遊，或追著游標跑。 +* 爬牆 - 讓它沿著視窗邊緣爬。 +* 坐在視窗上 - 讓它停在其他視窗的上緣。 +* 對話泡泡 - 依時段、餵食等情況說幾句短話。 +* 把話說出來 - 用語音把那些話唸出來。 +* 玩鬼抓人 - 兩隻以上的寵物會互相追逐。 +* 跟著聲音反應 - 寵物會隨聲音起伏動作。可以跟著**喇叭**或**麥克風**； + 兩者都只讀取音量電表（一個數字），不會擷取說話內容。僅 Windows 有效。 +* AI 聊天（需要 API 金鑰） - 和它對話。會讀取 ANTHROPIC_API_KEY 環境變數， + 金鑰不會被儲存。 +* 專注計時（分） - 寵物幫你看著的工作計時器，中間會安排休息。 + +把檔案拖到寵物身上就是餵它；拖圖片或寵物包則是換造型。 diff --git a/docs/source/docs/Zh/presentation.rst b/docs/source/docs/Zh/presentation.rst new file mode 100644 index 0000000..1744133 --- /dev/null +++ b/docs/source/docs/Zh/presentation.rst @@ -0,0 +1,18 @@ +簡報頁面 +-------- + +* 螢幕塗鴉 - 直接在畫面上畫。 + + * 筆、螢光筆、橡皮擦，顏色與粗細可選。 + * 「復原」收回最後一筆，「清除」清掉全部。 + * 塗鴉開啟時這一層會接收滑鼠；這一頁其他功能都讓點擊穿透。 + +* 游標強調 - 「高亮環」在游標周圍畫一圈，「點擊漣漪」顯示你按了哪裡， + 「聚光燈」把游標以外的地方壓暗。 +* 按鍵顯示 - 顯示你按下的按鍵，錄影和教學時很有用。 +* 放大鏡 - 跟著游標的鏡頭，1.5 倍到 6 倍。 +* 白板 - 一塊無限畫布。 + + * 按住中鍵拖曳可平移，滾輪縮放。 + * 筆畫存的是畫布座標，所以平移縮放之後線條還在原本該在的地方。 + * 「儲存白板」只輸出你實際畫過的範圍。 diff --git a/docs/source/docs/Zh/release_process.rst b/docs/source/docs/Zh/release_process.rst index 2728fc3..6200728 100644 --- a/docs/source/docs/Zh/release_process.rst +++ b/docs/source/docs/Zh/release_process.rst @@ -1,5 +1,5 @@ 發布流程 ----- +-------- FrontEngine 會在 pull request 合併到 ``main`` 時，以 ``frontengine`` 的名義 發布到 PyPI。開發工作都在 ``dev`` 分支進行，要發版時就開一個指向 ``main`` @@ -9,7 +9,7 @@ FrontEngine 會在 pull request 合併到 ``main`` 時，以 ``frontengine`` 的 驅動。 工作流程 -==== +======== * ``ci.yml`` — *CI* @@ -37,7 +37,7 @@ FrontEngine 會在 pull request 合併到 ``main`` 時，以 ``frontengine`` 的 版本不會被重複發布。 發布新版本 -==== +========== 1. 把 pull request 合併進 ``main``，patch 版號會自動遞增。 2. 同一次工作流程執行就會發布到 PyPI 並建立 GitHub 發行版。 @@ -47,7 +47,7 @@ FrontEngine 會在 pull request 合併到 ``main`` 時，以 ``frontengine`` 的 選擇 ``bump`` 段位。 必要的 Secrets -==== +============== 請在 repository secrets 中設定： diff --git a/docs/source/docs/Zh/scene.rst b/docs/source/docs/Zh/scene.rst index 4f0e762..2a68abc 100644 --- a/docs/source/docs/Zh/scene.rst +++ b/docs/source/docs/Zh/scene.rst @@ -1,28 +1,18 @@ 場景頁面 ----- +-------- .. image:: ../image/scene/scene.png -當您切換到場景選項卡時，您會注意到它下方有一個子選項卡。 -場景選項卡允許您同時播放多個場景。 +一個場景可以同時放好幾種覆蓋層，並存成檔案。 -以下是可用選項的詳細說明： - -* 場景控制面板： - * 查看您已加載的場景數量。 - * 儲存場景檔案。 - * 開始所有場景。 -* 圖片： - * 將圖片場景添加到場景檔案中。 -* GIF 和 WEBP： - * 在場景檔案中包含GIF和WEBP場景。 -* 文字： - * 將文字場景添加到場景檔案中。 -* 影片： - * 添加影片場景至場景檔案中。 -* 網頁： - * 將網頁場景添加到場景檔案中。 -* 音效： - * 在場景檔案中添加音效場景。 -* 外部UI： - * 將外部UI場景添加到場景檔案中。 \ No newline at end of file +* 加入網頁到場景 - 位址與不透明度。 +* 加入影片到場景 - 檔案、不透明度、播放速度、音量。 +* 加入圖片到場景 - 檔案與不透明度。 +* 加入 GIF 到場景 - 檔案、不透明度、速度。 +* 加入音效到場景 - 檔案與音量。 +* 加入文字到場景 - 文字、不透明度、字體大小、對齊。 +* 開始場景 - 顯示所有加進去的東西。 +* 輸出場景檔 - 把組好的內容存起來。 +* 載入場景檔 - 把存過的場景叫回來。 +* 清除所有腳本 - 重新開始。 +* 顯示在所有螢幕 - 每個螢幕各一份。 diff --git a/docs/source/docs/Zh/screen_care.rst b/docs/source/docs/Zh/screen_care.rst new file mode 100644 index 0000000..5203bca --- /dev/null +++ b/docs/source/docs/Zh/screen_care.rst @@ -0,0 +1,10 @@ +護眼頁面 +-------- + +* 螢幕濾鏡 - 在畫面上蓋一層暖色、琥珀、玫瑰、黃、綠、藍或灰，強度可調。 +* 閱讀尺 - 一條跟著游標移動的橫帶，長篇文字不容易看丟行。 +* 護眼休息（分／秒） - 每隔幾分鐘把畫面調暗幾秒，然後還給你。 +* 色覺 - 模擬紅色盲、綠色盲、藍色盲或全色盲，用來檢查設計出來的東西還讀不讀得懂。 +* 顯示在所有螢幕 / 目標螢幕 - 和其他分頁相同。 + +這些覆蓋層都讓點擊穿透，底下的東西照常可以操作。 diff --git a/docs/source/docs/Zh/sound.rst b/docs/source/docs/Zh/sound.rst index 55907e4..36d98e3 100644 --- a/docs/source/docs/Zh/sound.rst +++ b/docs/source/docs/Zh/sound.rst @@ -1,10 +1,10 @@ 音樂頁面 ----- +-------- .. image:: ../image/sound/sound.png -* 音樂選項卡具有以下選項: - * 音量: 音量趴數 (100 = 100%) -* 按鈕 - * 選擇 wav 檔案 (選擇 .wav 檔案來播放) - * 選擇 sound 檔案 (選擇 .mp3 .mp4 .wav 檔案來播放) +* 選擇 wav 檔 - 挑一個 wav。 +* 開始播放 Wav - 播放它。 +* 選擇音效檔 - 挑其他音訊格式。 +* 開始播放 - 播放它。 +* 音量 - 聲音大小。 diff --git a/docs/source/docs/Zh/text.rst b/docs/source/docs/Zh/text.rst index 9168d65..d855b0e 100644 --- a/docs/source/docs/Zh/text.rst +++ b/docs/source/docs/Zh/text.rst @@ -1,12 +1,22 @@ 文字頁面 ----- +-------- .. image:: ../image/text/text.png -* 文字選項卡具有以下選項: - * 不透明度：文字的不透明度。 - * 字體大小: 文字的大小 - * 在所有螢幕上顯示（在所有屏幕上顯示圖片）。 - * 在所有視窗底部顯示（圖片將在所有視窗底部隱藏）。 -* 按鈕 - * 開始繪製文字到螢幕 (繪製使用者提供的文字) \ No newline at end of file +* 開始在螢幕上顯示文字 - 顯示文字。 +* 不透明度 - 文字有多透明。 +* 字體大小、字體、顏色 - 外觀設定。 +* 外框 - 加上對比色的邊，疊在任何背景上都看得清楚。 +* 選擇文字對齊 - 靠哪個角落或置中。 +* 跑馬燈 - 讓文字橫向捲動，速度可調。 +* 文字來源 - 文字從哪裡來。 + + * 固定文字 - 輸入框裡是什麼就顯示什麼。 + * 時鐘 / 日期 - 輸入框是 strftime 格式。 + * 倒數計時 - 可填分鐘數、HH:MM 或完整日期。 + * 碼表 - 從啟動那一刻開始往上計時。 + * 系統狀態 - 可用 {cpu} {ram} {disk} {down} {up} 這些欄位。 + * 天氣 - 可用 {temperature} {description} {humidity} {wind} 等欄位， + 城市由「天氣城市」決定。 + +* 顯示在所有螢幕 / 顯示在所有視窗底下 / 目標螢幕 - 和其他分頁相同。 diff --git a/docs/source/docs/Zh/tools.rst b/docs/source/docs/Zh/tools.rst new file mode 100644 index 0000000..f6b4f50 --- /dev/null +++ b/docs/source/docs/Zh/tools.rst @@ -0,0 +1,22 @@ +工具頁面 +-------- + +* 量測 - 點擊開始量測，右鍵清除。量到的結果會直接複製到剪貼簿。 + + * 取色器 - 游標底下的顏色，可複製成 #rrggbb、rgb(...)、hsl(...) + 或 CSS 自訂屬性。 + * 像素尺 - 兩點之間的距離。 + * 量角器 - 三點構成的角度。 + +* 區域截圖 - 框出一塊範圍，結果會進剪貼簿；「複製上一張」可以再放一次。 +* 讀取文字 - 框出一塊範圍，複製其中的文字、翻譯它，或針對它提問。 + 這會把框選的畫面送到 Anthropic 的 API，所以會先徵求同意， + 並使用你自己的 ANTHROPIC_API_KEY。 +* 區域錄影 - 錄下畫面的一部分，張數與長度可調，也可以把攝影機疊在角落。 +* 虛擬攝影機 - 把一塊畫面連同覆蓋層一起當成網路攝影機送出， + Zoom、Teams 或 Discord 都能選它當視訊來源。需要選用套件 pyvirtualcam + 與虛擬攝影機驅動；缺其中之一時按鈕會直接說明。 +* 攝影機 - 顯示任何視訊輸入（含擷取卡），可選圓形、圓角或矩形， + 並加上邊框或鏡像。只在本機顯示，不會錄下任何東西。 +* 釘選視窗… - 讓其他程式的視窗保持在最上層，並調整它的透明度。僅 Windows 有效。 +* 視窗版面 - 記住視窗現在的位置，之後再擺回來。 diff --git a/docs/source/docs/Zh/ui.rst b/docs/source/docs/Zh/ui.rst index 8bba7ab..e85cadd 100644 --- a/docs/source/docs/Zh/ui.rst +++ b/docs/source/docs/Zh/ui.rst @@ -1,18 +1,35 @@ -怎麼使用 UI ----- +如何使用 +-------- .. image:: ../image/main/FrontEngine.png -* 選擇語言選單 (選擇使用者介面語言) -* 選擇介面風格 (選擇使用者介面風格) -* 分頁選單 - * 影片 (設定並顯示影片在前景) - * 圖片 (設定並顯示圖片在前景) - * 網頁 (設定並顯示網頁在前景) - * GIF 和 WEBP (設定並顯示 GIF 或 WEBP 在前景) - * 音樂 (設定並撥放音樂) - * 文字 (設定並顯示文字在前景) - * 場景 (添加多個組件並同時顯示多個組件，可以把設定存為檔案) - * 聊天 (在前景與 Bing 助手聊天) - * 控制中心 (控制所有其他組件) - * 圖片產生 (用文字產生圖片) +選單列 + +* 選擇語言 - 七種語言：English、繁體中文、简体中文、Deutsch、Русский、Français、Italiano。 + 切換後畫面立刻改變，不需要重新啟動，開著的東西也都留在原地。 +* 選擇 UI 樣式 - 選擇配色主題，也可以讓它依日夜自動切換。 +* 預設集 - 把各分頁目前的設定整組記下來，之後再叫回來。 +* 設定 - 快速鍵、日夜主題、開機啟動、智慧暫停、應用情境、提醒、看板模式、 + 手機遙控、螢幕分享隱私、螢幕使用時間與剪貼簿歷史。 +* 幫助 / 文件 - 問題回報與這份文件。 + +分頁 + +* 影片 - 在最上層播放影片。 +* 圖片 - 顯示圖片，或把整個資料夾當幻燈片播。 +* 網頁 - 顯示網頁，或輪播一組儀表板。 +* GIF 和 WEBP - 顯示動畫。 +* 音樂 - 播放 wav 或其他音訊格式。 +* 文字 - 顯示文字、時鐘、倒數、系統狀態或天氣。 +* 場景 - 把上面幾種組合起來，並存成檔案。 +* 粒子 - 在桌面上灑粒子效果。 +* 寵物 - 會走動、爬牆、對你有反應的桌面夥伴。 +* 護眼 - 螢幕濾鏡、閱讀尺、休息提醒、色覺模擬。 +* 簡報 - 螢幕塗鴉、游標強調、按鍵顯示、放大鏡、白板。 +* 桌布 - 位於所有視窗之下的動態桌布。 +* 專注 - 調暗背景，或把會分心的東西遮起來。 +* 小工具 - 音訊頻譜、系統監控、正在播放、便條紙。 +* 工具 - 量測、截圖、讀取文字、錄影、虛擬攝影機、攝影機、視窗釘選。 +* 控制中心 - 一次控制所有覆蓋層。 + +除了寵物與塗鴉層之外，所有覆蓋層都讓點擊穿透，底下的東西照常可以操作。 diff --git a/docs/source/docs/Zh/video.rst b/docs/source/docs/Zh/video.rst index e961669..b18c913 100644 --- a/docs/source/docs/Zh/video.rst +++ b/docs/source/docs/Zh/video.rst @@ -1,14 +1,15 @@ 影片頁面 ----- +-------- .. image:: ../image/video/video.png -* 影片選項卡具有以下選項: - * 不透明度: 影片的不透明度 - * 撥放速率: 影片的播放速率趴數 (100 = 100%) - * 音量: 影片的撥放音量趴數 (100 = 100%) - * 在所有螢幕上顯示（在所有屏幕上顯示圖片）。 - * 在所有視窗底部顯示（圖片將在所有視窗底部隱藏）。 -* 按鈕 - * 選擇影片檔案 (用來選擇你想播放的 .mp4 檔案) - * 開始播放影片 (讀取設定並開始播放) \ No newline at end of file +* 選擇影片檔 - 挑要播放的檔案。 +* 開始播放影片 - 顯示它。 +* 不透明度 - 影片有多透明。 +* 播放速度 - 播放的快慢。 +* 音量 - 聲音大小。 +* 全螢幕 - 拉伸到整個螢幕。 +* 顯示在所有螢幕 - 每個螢幕各一份。 +* 顯示在所有視窗底下 - 放到其他視窗之下。 +* 目標螢幕 - 要用哪個螢幕，或每次詢問。 +* 最近使用 - 之前播過的檔案。 diff --git a/docs/source/docs/Zh/wallpaper.rst b/docs/source/docs/Zh/wallpaper.rst new file mode 100644 index 0000000..288b5eb --- /dev/null +++ b/docs/source/docs/Zh/wallpaper.rst @@ -0,0 +1,14 @@ +桌布頁面 +-------- + +桌布位於所有視窗之下，所以永遠不會擋路。 + +* 螢幕 - 每個螢幕可以用各自的資料夾。 +* 選擇資料夾… - 圖片或影片放在哪裡。 +* 更換間隔 - 每張停留多久，30 秒到 1 小時。 +* 隨機 - 打亂順序。 +* 包含子資料夾 - 連巢狀資料夾一起找。 +* 跟著聲音變化 - 桌布會隨喇叭正在播的聲音起伏。這只讀取音量電表， + 不是聲音本身。僅 Windows 有效。 +* 安靜時段 - 在指定的兩個時間之間改用「安靜時段資料夾」，工作時清爽一點。 +* 啟動桌布 / 下一張桌布 - 開始，或立刻換下一張。 diff --git a/docs/source/docs/Zh/web.rst b/docs/source/docs/Zh/web.rst index 84e4745..583418b 100644 --- a/docs/source/docs/Zh/web.rst +++ b/docs/source/docs/Zh/web.rst @@ -1,13 +1,17 @@ 網頁頁面 ----- +-------- .. image:: ../image/web/web.png -* 網頁選項卡具有以下選項: - * 不透明度：網頁的不透明度。 - * 開始本地檔案 (開啟本地 HTML 檔案 <你可以使用 javascript 和 css> ) - * 開啟輸入 (開啟網頁輸入) - * 在所有螢幕上顯示（在所有屏幕上顯示圖片）。 - * 在所有視窗底部顯示（圖片將在所有視窗底部隱藏）。 -* 按鈕 - * 用 URL 開啟網頁 (用使用者輸入的網址開啟網頁) \ No newline at end of file +* 以網址開啟網頁 - 顯示輸入框裡的位址。 +* 開啟本機檔案 - 把輸入框當成本機 html 檔的路徑。 +* 允許輸入 - 讓網頁可以接收點擊與鍵盤輸入。 +* 不透明度 - 網頁有多透明。 +* 縮放 - 網頁縮放，50% 到 200%。 +* 自動重新整理 - 每 30 秒到每 15 分鐘重新載入一次。 +* 儀表板網址 - 一行一個位址；以 # 開頭的行會被忽略。 + + * 啟動儀表板 - 依序輪播那些位址。 + * 下一頁 - 立刻換下一個。 + +* 顯示在所有螢幕 / 顯示在所有視窗底下 / 目標螢幕 - 和其他分頁相同。 diff --git a/docs/source/docs/Zh/widgets.rst b/docs/source/docs/Zh/widgets.rst new file mode 100644 index 0000000..83fd263 --- /dev/null +++ b/docs/source/docs/Zh/widgets.rst @@ -0,0 +1,10 @@ +小工具頁面 +---------- + +* 音訊頻譜 - 隨喇叭播放的聲音起伏的長條或環形，頻段數可調。 + 這一項確實會擷取音訊，但只在記憶體裡分析以計算頻率；不會錄下也不會送出， + 停止頻譜就停止擷取。僅 Windows 有效。 +* 系統監控 - 以小面板常駐顯示 CPU、記憶體、磁碟與網路。 +* 顯示正在播放 - 你的播放器現在放到哪一首。 +* 便條紙 - 「新便條」在桌面上貼一張，「關閉便條」清掉全部。 + 勾選「FrontEngine 啟動時重新打開我的便條」下次就會自動回來。 diff --git a/docs/source/docs/Zh/zh_index.rst b/docs/source/docs/Zh/zh_index.rst index aace94d..539ec43 100644 --- a/docs/source/docs/Zh/zh_index.rst +++ b/docs/source/docs/Zh/zh_index.rst @@ -1,5 +1,5 @@ FrontEngine 繁體中文 文件 ----- +------------------------- .. toctree:: :maxdepth: 4 @@ -12,6 +12,15 @@ FrontEngine 繁體中文 文件 sound.rst text.rst scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst control_center.rst + menus.rst how_to_extend_ui.rst release_process.rst diff --git a/docs/source/docs/ZhCn/control_center.rst b/docs/source/docs/ZhCn/control_center.rst new file mode 100644 index 0000000..3126391 --- /dev/null +++ b/docs/source/docs/ZhCn/control_center.rst @@ -0,0 +1,25 @@ +控制中心页面 +------------ + +.. image:: ../image/control_center/control_center.png + +这一页能碰到所有覆盖层，包含其他页面打开的那些。 + +关闭 + +* 关闭所有视频／图片／GIF／网页／音效／文字 - 只关那一类。 +* 关闭所有 - 关掉画面上每一个覆盖层，不管是哪一页打开的。 +* 清除日志 - 清空右侧的消息区。 + +整批操作 + +* 全部隐藏 / 全部显示 - 暂时收起来，再调回来。 +* 全部静音 - 让所有会出声的东西安静。 +* 锁定 / 解除锁定覆盖层 - 解除锁定后可以用鼠标把覆盖层拖到想要的位置， + 松开时位置会被记住；锁定时则让点击穿透。 +* 抠像色 - 把背景涂成单一颜色，方便在 OBS 之类的软件里抠像。 +* 重置覆盖层位置 - 全部摆回一开始的地方。 +* 省电模式 - 在意电池时降低刷新率与渲染分辨率。 +* 画质 - 高、平衡、省电，是上面那件事更细的版本。 +* 从画面捕获中隐藏 - 覆盖层留在你自己的屏幕上，但不会出现在屏幕共享的结果里。 + 仅 Windows 有效。专注页的遮挡层会保持可见——遮住东西正是它唯一的用途。 diff --git a/docs/source/docs/ZhCn/focus.rst b/docs/source/docs/ZhCn/focus.rst new file mode 100644 index 0000000..9dd72fe --- /dev/null +++ b/docs/source/docs/ZhCn/focus.rst @@ -0,0 +1,10 @@ +专注页面 +-------- + +* 调暗背景窗口 - 把正在使用的窗口以外的地方压暗，强度可调。 +* 遮住干扰 - 遮掉画面的某一块：任务栏所在的底部横条、右下角、顶部横条、 + 左右任一侧边，或整个屏幕。 +* 目标屏幕 - 要用哪个屏幕，或每次询问。 + +两者都让点击穿透：被遮住的东西照常能用，只是不再抢你的注意力。 +遮挡层在屏幕共享时也会保持可见——遮住东西正是它唯一的用途。 diff --git a/docs/source/docs/ZhCn/gif_and_webp.rst b/docs/source/docs/ZhCn/gif_and_webp.rst new file mode 100644 index 0000000..f91cda9 --- /dev/null +++ b/docs/source/docs/ZhCn/gif_and_webp.rst @@ -0,0 +1,14 @@ +GIF 和 WEBP 页面 +---------------- + +.. image:: ../image/gif_and_webp/gif_and_webp.png + +* 选择 GIF 或 WEBP 文件 - 挑要播放的动画。 +* 开始播放 GIF 或 WEBP - 显示它。 +* 不透明度 - 动画有多透明。 +* 速度 - 播放的快慢。 +* 全屏 - 拉伸到整个屏幕。 +* 显示在所有屏幕 - 每个屏幕各一份。 +* 显示在所有窗口底下 - 放到其他窗口之下。 +* 目标屏幕 - 要用哪个屏幕，或每次询问。 +* 最近使用 - 之前播放过的动画。 diff --git a/docs/source/docs/ZhCn/image.rst b/docs/source/docs/ZhCn/image.rst new file mode 100644 index 0000000..38d2ea3 --- /dev/null +++ b/docs/source/docs/ZhCn/image.rst @@ -0,0 +1,20 @@ +图片页面 +-------- + +.. image:: ../image/image_page/image_page.png + +* 选择图片 - 挑要显示的图片。 +* 开始显示图片 - 显示它。 +* 不透明度 - 图片有多透明。 +* 全屏 - 拉伸到整个屏幕。 +* 显示在所有屏幕 - 每个屏幕各一份。 +* 显示在所有窗口底下 - 放到其他窗口之下。 +* 幻灯片 - 依次显示文件夹里的每一张图。 + + * 选择文件夹 - 图片放在哪里。 + * 间隔 - 每张停留几秒。 + * 随机播放 - 打乱顺序。 + * 包含子文件夹 - 连嵌套文件夹一起查找。 + +* 目标屏幕 - 要用哪个屏幕，或每次询问。 +* 最近使用 - 之前显示过的图片。 diff --git a/docs/source/docs/ZhCn/menus.rst b/docs/source/docs/ZhCn/menus.rst new file mode 100644 index 0000000..fc58d58 --- /dev/null +++ b/docs/source/docs/ZhCn/menus.rst @@ -0,0 +1,37 @@ +预设与设定 +---------- + +预设菜单 + +* 保存预设… - 把各页面当前的设置整组记下来，取个名字。 +* 载入预设… - 调回来。 +* 删除预设… +* 导出预设… / 导入预设… - 以 json 文件在不同机器之间搬移。 +* 导出打包（含素材） / 导入打包（含素材） - 同上，但连它用到的图片、视频、 + 音效一起打包成 zip。 +* 设为启动预设… - FrontEngine 启动时自动应用。 +* 导入创意工坊内容… - 安装你在 Steam 上订阅的预设与宠物包。 + +设定菜单 + +* 快捷键… - 全部隐藏、全部显示、全部关闭、全部静音、提高／降低不透明度、 + 下一页仪表板与锁定的全局快捷键。 +* 日夜主题自动切换 - 白天亮色、晚上暗色。 +* 开机时启动 - 登录时自动打开 FrontEngine。 +* 恢复上次的会话 - 重新打开上次画面上的东西。 +* 载入插件（进阶） - 插件是 Python 程序，与 FrontEngine 同权限执行， + 只安装你信任的。 +* 智能暂停… - 有全屏程序在跑、使用电池，或指定程序取得焦点时，把覆盖层收起来。 +* 应用情境… - 某个程序切到前台时自动应用指定的预设。 +* 提醒… - 每隔几分钟，或在固定时刻提醒你一句话。 +* 看板模式… - 依次轮播一组预设，适合把机器摆着当展示屏幕。 + 运行时主窗口可以收进系统托盘——但只有在托盘真的能把它调回来时才会收。 +* 手机遥控… - 用同一个网络上的手机控制 FrontEngine，也可以绑 MIDI 控制器。 + 链接带的是一次性令牌，每次启动都会更换，而且只有页面上那些按钮能被触发。 + 它走的是纯 HTTP，在你不信任的网络上请保持关闭。 +* 屏幕共享隐私… - 会议程序开着时，把覆盖层从画面捕获中隐藏。 + 比对的是窗口标题，所以在浏览器标签页里开的会议也能识别。仅 Windows 有效。 +* 屏幕使用时间… - 你在每个程序上花了多久。只存在这台机器上，不会发送到任何地方。 +* 剪贴板历史… - 最近复制过的内容，可搜索、可置顶。 + 除非你要求保留，否则只存在内存里——因为剪贴板常常有密码。 +* 导出设定… / 导入设定… diff --git a/docs/source/docs/ZhCn/particle.rst b/docs/source/docs/ZhCn/particle.rst new file mode 100644 index 0000000..960c9c1 --- /dev/null +++ b/docs/source/docs/ZhCn/particle.rst @@ -0,0 +1,11 @@ +粒子页面 +-------- + +* 选择图片 - 每个粒子用哪张图绘制。 +* 开始播放粒子 - 开始效果。 +* 选择粒子方向 - 向下、向上、向左或向右。 +* 粒子大小、粒子数量、粒子速度 - 决定这个效果有多吃资源。 + 少一点、慢一点就省一些；控制中心的画质档位可以一次把所有覆盖层再降一级。 +* 不透明度 - 粒子有多透明。 +* 显示在所有屏幕 - 每个屏幕各一份。 +* 目标屏幕 - 要用哪个屏幕，或每次询问。 diff --git a/docs/source/docs/ZhCn/pet.rst b/docs/source/docs/ZhCn/pet.rst new file mode 100644 index 0000000..4dbadb6 --- /dev/null +++ b/docs/source/docs/ZhCn/pet.rst @@ -0,0 +1,24 @@ +宠物页面 +-------- + +一只住在桌面上的伙伴。 + +* 选择宠物图片 - 单张图片。 +* 选择宠物包… - 一个文件夹，里面有 walk / idle / sleep / climb / fall / drag + 这些动作的图，宠物就会有动画。 +* 选择音效（可不选） - 它会播放的声音。 +* 召唤宠物 - 放到画面上。再按一次会多一只。 +* 大小、速度 - 多大、多快。 +* 行为 - 在地面走动、自由漫游，或追着光标跑。 +* 爬墙 - 让它沿着窗口边缘爬。 +* 坐在窗口上 - 让它停在其他窗口的上沿。 +* 对话气泡 - 按时段、喂食等情况说几句短话。 +* 把话说出来 - 用语音把那些话念出来。 +* 玩捉迷藏 - 两只以上的宠物会互相追逐。 +* 跟着声音反应 - 宠物会随声音起伏动作。可以跟着**扬声器**或**麦克风**； + 两者都只读取音量电平（一个数字），不会捕获说话内容。仅 Windows 有效。 +* AI 聊天（需要 API 密钥） - 和它对话。会读取 ANTHROPIC_API_KEY 环境变量， + 密钥不会被保存。 +* 专注计时（分） - 宠物帮你看着的工作计时器，中间会安排休息。 + +把文件拖到宠物身上就是喂它；拖图片或宠物包则是换造型。 diff --git a/docs/source/docs/ZhCn/presentation.rst b/docs/source/docs/ZhCn/presentation.rst new file mode 100644 index 0000000..80909ad --- /dev/null +++ b/docs/source/docs/ZhCn/presentation.rst @@ -0,0 +1,18 @@ +演示页面 +-------- + +* 屏幕涂鸦 - 直接在画面上绘制。 + + * 笔、荧光笔、橡皮擦，颜色与粗细可选。 + * 「撤销」收回最后一笔，「清除」清掉全部。 + * 涂鸦开启时这一层会接收鼠标；这一页其他功能都让点击穿透。 + +* 光标强调 - 「高亮环」在光标周围画一圈，「点击涟漪」显示你点了哪里， + 「聚光灯」把光标以外的地方压暗。 +* 按键显示 - 显示你按下的按键，录屏和教学时很有用。 +* 放大镜 - 跟着光标的镜头，1.5 倍到 6 倍。 +* 白板 - 一块无限画布。 + + * 按住中键拖动可平移，滚轮缩放。 + * 笔画保存的是画布坐标，所以平移缩放之后线条还在原本该在的地方。 + * 「保存白板」只输出你实际画过的范围。 diff --git a/docs/source/docs/ZhCn/scene.rst b/docs/source/docs/ZhCn/scene.rst new file mode 100644 index 0000000..473a43f --- /dev/null +++ b/docs/source/docs/ZhCn/scene.rst @@ -0,0 +1,18 @@ +场景页面 +-------- + +.. image:: ../image/scene/scene.png + +一个场景可以同时放好几种覆盖层，并保存为文件。 + +* 添加网页到场景 - 地址与不透明度。 +* 添加视频到场景 - 文件、不透明度、播放速度、音量。 +* 添加图片到场景 - 文件与不透明度。 +* 添加 GIF 到场景 - 文件、不透明度、速度。 +* 添加音效到场景 - 文件与音量。 +* 添加文字到场景 - 文字、不透明度、字号、对齐。 +* 开始场景 - 显示所有添加进去的东西。 +* 输出场景文件 - 把组好的内容保存起来。 +* 载入场景文件 - 把保存过的场景调回来。 +* 清除所有脚本 - 重新开始。 +* 显示在所有屏幕 - 每个屏幕各一份。 diff --git a/docs/source/docs/ZhCn/screen_care.rst b/docs/source/docs/ZhCn/screen_care.rst new file mode 100644 index 0000000..06882c2 --- /dev/null +++ b/docs/source/docs/ZhCn/screen_care.rst @@ -0,0 +1,10 @@ +护眼页面 +-------- + +* 屏幕滤镜 - 在画面上盖一层暖色、琥珀、玫瑰、黄、绿、蓝或灰，强度可调。 +* 阅读尺 - 一条跟着光标移动的横带，长篇文字不容易看丢行。 +* 护眼休息（分／秒） - 每隔几分钟把画面调暗几秒，然后还给你。 +* 色觉 - 模拟红色盲、绿色盲、蓝色盲或全色盲，用来检查设计出来的东西还读不读得懂。 +* 显示在所有屏幕 / 目标屏幕 - 和其他页面相同。 + +这些覆盖层都让点击穿透，底下的东西照常可以操作。 diff --git a/docs/source/docs/ZhCn/sound.rst b/docs/source/docs/ZhCn/sound.rst new file mode 100644 index 0000000..ba83dc4 --- /dev/null +++ b/docs/source/docs/ZhCn/sound.rst @@ -0,0 +1,10 @@ +音乐页面 +-------- + +.. image:: ../image/sound/sound.png + +* 选择 wav 文件 - 挑一个 wav。 +* 开始播放 Wav - 播放它。 +* 选择音效文件 - 挑其他音频格式。 +* 开始播放 - 播放它。 +* 音量 - 声音大小。 diff --git a/docs/source/docs/ZhCn/text.rst b/docs/source/docs/ZhCn/text.rst new file mode 100644 index 0000000..d8e7917 --- /dev/null +++ b/docs/source/docs/ZhCn/text.rst @@ -0,0 +1,22 @@ +文字页面 +-------- + +.. image:: ../image/text/text.png + +* 开始在屏幕上显示文字 - 显示文字。 +* 不透明度 - 文字有多透明。 +* 字号、字体、颜色 - 外观设置。 +* 描边 - 加上对比色的边，叠在任何背景上都看得清楚。 +* 选择文字对齐 - 靠哪个角落或居中。 +* 跑马灯 - 让文字横向滚动，速度可调。 +* 文字来源 - 文字从哪里来。 + + * 固定文字 - 输入框里是什么就显示什么。 + * 时钟 / 日期 - 输入框是 strftime 格式。 + * 倒计时 - 可填分钟数、HH:MM 或完整日期。 + * 秒表 - 从启动那一刻开始往上计时。 + * 系统状态 - 可用 {cpu} {ram} {disk} {down} {up} 这些字段。 + * 天气 - 可用 {temperature} {description} {humidity} {wind} 等字段， + 城市由「天气城市」决定。 + +* 显示在所有屏幕 / 显示在所有窗口底下 / 目标屏幕 - 和其他页面相同。 diff --git a/docs/source/docs/ZhCn/tools.rst b/docs/source/docs/ZhCn/tools.rst new file mode 100644 index 0000000..2355d6e --- /dev/null +++ b/docs/source/docs/ZhCn/tools.rst @@ -0,0 +1,22 @@ +工具页面 +-------- + +* 测量 - 点击开始测量，右键清除。测到的结果会直接复制到剪贴板。 + + * 取色器 - 光标底下的颜色，可复制成 #rrggbb、rgb(...)、hsl(...) + 或 CSS 自定义属性。 + * 像素尺 - 两点之间的距离。 + * 量角器 - 三点构成的角度。 + +* 区域截图 - 框出一块范围，结果会进剪贴板；「复制上一张」可以再放一次。 +* 读取文字 - 框出一块范围，复制其中的文字、翻译它，或针对它提问。 + 这会把框选的画面发送到 Anthropic 的 API，所以会先征求同意， + 并使用你自己的 ANTHROPIC_API_KEY。 +* 区域录屏 - 录下画面的一部分，帧数与长度可调，也可以把摄像头叠在角落。 +* 虚拟摄像头 - 把一块画面连同覆盖层一起当成网络摄像头发送， + Zoom、Teams 或 Discord 都能选它当视频来源。需要可选包 pyvirtualcam + 与虚拟摄像头驱动；缺其中之一时按钮会直接说明。 +* 摄像头 - 显示任何视频输入（含采集卡），可选圆形、圆角或矩形， + 并加上边框或镜像。只在本机显示，不会录下任何东西。 +* 置顶窗口… - 让其他程序的窗口保持在最上层，并调整它的透明度。仅 Windows 有效。 +* 窗口布局 - 记住窗口现在的位置，之后再摆回来。 diff --git a/docs/source/docs/ZhCn/ui.rst b/docs/source/docs/ZhCn/ui.rst new file mode 100644 index 0000000..a953714 --- /dev/null +++ b/docs/source/docs/ZhCn/ui.rst @@ -0,0 +1,35 @@ +如何使用 +-------- + +.. image:: ../image/main/FrontEngine.png + +菜单栏 + +* 选择语言 - 七种语言：English、繁體中文、简体中文、Deutsch、Русский、Français、Italiano。 + 切换后界面立刻改变，不需要重新启动，已经打开的东西也都留在原地。 +* 选择 UI 样式 - 选择配色主题，也可以让它按日夜自动切换。 +* 预设 - 把各页面当前的设置整组记下来，之后再调回来。 +* 设定 - 快捷键、日夜主题、开机启动、智能暂停、应用情境、提醒、看板模式、 + 手机遥控、屏幕共享隐私、屏幕使用时间与剪贴板历史。 +* 帮助 / 文档 - 问题反馈与这份文档。 + +标签页 + +* 视频 - 在最上层播放视频。 +* 图片 - 显示图片，或把整个文件夹当幻灯片播放。 +* 网页 - 显示网页，或轮播一组仪表板。 +* GIF 和 WEBP - 显示动画。 +* 音乐 - 播放 wav 或其他音频格式。 +* 文字 - 显示文字、时钟、倒计时、系统状态或天气。 +* 场景 - 把上面几种组合起来，并保存为文件。 +* 粒子 - 在桌面上撒粒子效果。 +* 宠物 - 会走动、爬墙、对你有反应的桌面伙伴。 +* 护眼 - 屏幕滤镜、阅读尺、休息提醒、色觉模拟。 +* 演示 - 屏幕涂鸦、光标强调、按键显示、放大镜、白板。 +* 壁纸 - 位于所有窗口之下的动态壁纸。 +* 专注 - 调暗背景，或把会分心的东西遮起来。 +* 小工具 - 音频频谱、系统监控、正在播放、便签。 +* 工具 - 测量、截图、读取文字、录屏、虚拟摄像头、摄像头、窗口置顶。 +* 控制中心 - 一次控制所有覆盖层。 + +除了宠物与涂鸦层之外，所有覆盖层都让点击穿透，底下的东西照常可以操作。 diff --git a/docs/source/docs/ZhCn/video.rst b/docs/source/docs/ZhCn/video.rst new file mode 100644 index 0000000..4e35b8b --- /dev/null +++ b/docs/source/docs/ZhCn/video.rst @@ -0,0 +1,15 @@ +视频页面 +-------- + +.. image:: ../image/video/video.png + +* 选择视频文件 - 挑要播放的文件。 +* 开始播放视频 - 显示它。 +* 不透明度 - 视频有多透明。 +* 播放速度 - 播放的快慢。 +* 音量 - 声音大小。 +* 全屏 - 拉伸到整个屏幕。 +* 显示在所有屏幕 - 每个屏幕各一份。 +* 显示在所有窗口底下 - 放到其他窗口之下。 +* 目标屏幕 - 要用哪个屏幕，或每次询问。 +* 最近使用 - 之前播放过的文件。 diff --git a/docs/source/docs/ZhCn/wallpaper.rst b/docs/source/docs/ZhCn/wallpaper.rst new file mode 100644 index 0000000..f2a7a08 --- /dev/null +++ b/docs/source/docs/ZhCn/wallpaper.rst @@ -0,0 +1,14 @@ +壁纸页面 +-------- + +壁纸位于所有窗口之下，所以永远不会挡路。 + +* 屏幕 - 每个屏幕可以用各自的文件夹。 +* 选择文件夹… - 图片或视频放在哪里。 +* 更换间隔 - 每张停留多久，30 秒到 1 小时。 +* 随机 - 打乱顺序。 +* 包含子文件夹 - 连嵌套文件夹一起查找。 +* 跟着声音变化 - 壁纸会随扬声器正在播放的声音起伏。这只读取音量电平， + 不是声音本身。仅 Windows 有效。 +* 安静时段 - 在指定的两个时间之间改用「安静时段文件夹」，工作时清爽一点。 +* 启动壁纸 / 下一张壁纸 - 开始，或立刻换下一张。 diff --git a/docs/source/docs/ZhCn/web.rst b/docs/source/docs/ZhCn/web.rst new file mode 100644 index 0000000..5c3860b --- /dev/null +++ b/docs/source/docs/ZhCn/web.rst @@ -0,0 +1,17 @@ +网页页面 +-------- + +.. image:: ../image/web/web.png + +* 以网址打开网页 - 显示输入框里的地址。 +* 打开本地文件 - 把输入框当成本地 html 文件的路径。 +* 允许输入 - 让网页可以接收点击与键盘输入。 +* 不透明度 - 网页有多透明。 +* 缩放 - 网页缩放，50% 到 200%。 +* 自动刷新 - 每 30 秒到每 15 分钟重新加载一次。 +* 仪表板网址 - 一行一个地址；以 # 开头的行会被忽略。 + + * 启动仪表板 - 依次轮播那些地址。 + * 下一页 - 立刻换下一个。 + +* 显示在所有屏幕 / 显示在所有窗口底下 / 目标屏幕 - 和其他页面相同。 diff --git a/docs/source/docs/ZhCn/widgets.rst b/docs/source/docs/ZhCn/widgets.rst new file mode 100644 index 0000000..b91a962 --- /dev/null +++ b/docs/source/docs/ZhCn/widgets.rst @@ -0,0 +1,10 @@ +小工具页面 +---------- + +* 音频频谱 - 随扬声器播放的声音起伏的长条或环形，频段数可调。 + 这一项确实会捕获音频，但只在内存里分析以计算频率；不会录下也不会发送， + 停止频谱就停止捕获。仅 Windows 有效。 +* 系统监控 - 以小面板常驻显示 CPU、内存、磁盘与网络。 +* 显示正在播放 - 你的播放器现在放到哪一首。 +* 便签 - 「新便签」在桌面上贴一张，「关闭便签」清掉全部。 + 勾选「FrontEngine 启动时重新打开我的便签」下次就会自动回来。 diff --git a/docs/source/docs/ZhCn/zhcn_index.rst b/docs/source/docs/ZhCn/zhcn_index.rst new file mode 100644 index 0000000..095ce71 --- /dev/null +++ b/docs/source/docs/ZhCn/zhcn_index.rst @@ -0,0 +1,28 @@ +FrontEngine 简体中文 文档 +------------------------- + +.. toctree:: + :maxdepth: 4 + + ui.rst + video.rst + image.rst + web.rst + gif_and_webp.rst + sound.rst + text.rst + scene.rst + particle.rst + pet.rst + screen_care.rst + presentation.rst + wallpaper.rst + focus.rst + widgets.rst + tools.rst + control_center.rst + menus.rst + +---- + +贡献者文件（如何扩展 UI、发布流程）目前只有英文版，请见 English Documentation。 diff --git a/docs/source/index.rst b/docs/source/index.rst index 04f26d7..a26a999 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,11 +1,16 @@ FrontEngine ----- +----------- .. toctree:: :maxdepth: 4 docs/Eng/eng_index.rst docs/Zh/zh_index.rst + docs/ZhCn/zhcn_index.rst + docs/De/de_index.rst + docs/Ru/ru_index.rst + docs/Fr/fr_index.rst + docs/It/it_index.rst ---- @@ -16,4 +21,3 @@ RoadMap * Project Kanban * https://github.com/orgs/Integration-Automation/projects/2/views/1 ----- diff --git a/tests/unit_test/test_documentation.py b/tests/unit_test/test_documentation.py new file mode 100644 index 0000000..0a19e29 --- /dev/null +++ b/tests/unit_test/test_documentation.py @@ -0,0 +1,115 @@ +""" +文件的一致性測試。 + +寫這支測試的原因：文件曾經停在 2026-04-21，程式一路加到十六個分頁，文件卻只 +描述其中八個，還列了兩個早就不存在的分頁（CHAT、IMAGE GENERATION）。缺頁至少 +還看得出來是缺；寫錯的頁面則會誤導人。 + +現在有七種語言的文件樹，很容易變成「只在英文版加了一頁」。這裡守住三件事： +七棵樹的頁面集合一致、引用的圖片真的存在、以及文件不再提到已經移除的功能。 + +Documentation consistency. + +This exists because the documentation sat at 2026-04-21 while the application +grew to sixteen tabs: it described eight of them and listed two that no longer +existed (CHAT, IMAGE GENERATION). A missing page at least reads as missing; a +wrong one misleads. + +With seven language trees it is easy to add a page in English only. Three +things are pinned here: the trees carry the same pages, every referenced image +is really there, and nothing describes a feature that has been removed. +""" +import re +from pathlib import Path +from typing import Dict, Set + +import pytest + +DOCS = Path(__file__).resolve().parents[2] / "docs" / "source" / "docs" +# 只有 Eng / Zh 有貢獻者文件，其餘語言的 index 會指向英文版 +CONTRIBUTOR = {"how_to_extend_ui", "release_process"} +REMOVED = ["CHAT (Chat", "IMAGE GENERATION", "Crosshair", "Teleprompter", "Soundboard"] + + +def _trees() -> Dict[str, Set[str]]: + return {directory.name: {path.stem for path in directory.glob("*.rst")} + for directory in sorted(DOCS.iterdir()) + if directory.is_dir() and directory.name != "image"} + + +def _content_pages(pages: Set[str]) -> Set[str]: + return {name for name in pages + if not name.endswith("_index") and name not in CONTRIBUTOR} + + +def test_the_application_languages_all_have_documentation() -> None: + """介面支援的語言，文件也要有一棵樹。""" + assert set(_trees()) == {"Eng", "Zh", "ZhCn", "De", "Ru", "Fr", "It"} + + +@pytest.mark.parametrize("language", sorted(set(_trees()) - {"Eng"})) +def test_every_language_carries_the_same_pages(language: str) -> None: + trees = _trees() + expected = _content_pages(trees["Eng"]) + actual = _content_pages(trees[language]) + assert actual == expected, f"{language} differs: {sorted(actual ^ expected)}" + + +@pytest.mark.parametrize("language", sorted(_trees())) +def test_every_tree_has_exactly_one_index(language: str) -> None: + indexes = [name for name in _trees()[language] if name.endswith("_index")] + assert len(indexes) == 1, f"{language}: {indexes}" + + +def test_the_top_level_index_lists_every_language() -> None: + top = (DOCS.parent / "index.rst").read_text(encoding="utf-8") + for language in _trees(): + assert f"docs/{language}/" in top, f"{language} is not linked from the top index" + + +def test_every_referenced_image_exists() -> None: + """ + Sphinx 對缺少的圖片只給警告，頁面照樣產出，但讀者看到的是一個破圖。 + Sphinx only warns about a missing image and still emits the page, so the + reader is the one who finds the broken box. + """ + missing = [] + for path in DOCS.rglob("*.rst"): + for reference in re.findall(r"\.\. image:: (\S+)", path.read_text(encoding="utf-8")): + if not (path.parent / reference).resolve().exists(): + missing.append(f"{path.name} -> {reference}") + assert not missing, f"referenced but not present: {missing}" + + +@pytest.mark.parametrize("removed", REMOVED) +def test_nothing_documents_a_feature_that_was_removed(removed: str) -> None: + """ + 寫錯比沒寫更糟：文件曾經長年列著兩個不存在的分頁。 + A wrong page is worse than a missing one: the docs listed two tabs that had + not existed for a long time. + """ + guilty = [str(path.relative_to(DOCS)) for path in DOCS.rglob("*.rst") + if removed in path.read_text(encoding="utf-8")] + assert not guilty, f"{removed!r} still documented in: {guilty}" + + +def test_the_underlines_are_long_enough() -> None: + """ + 底線太短 docutils 每頁抱怨一次；十八頁乘七種語言就是一整牆的警告。 + 中日韓字元佔兩格，所以量的是顯示寬度而不是字元數。 + """ + import unicodedata + + def width(text: str) -> int: + return sum(2 if unicodedata.east_asian_width(c) in "WF" else 1 for c in text) + + short = [] + for path in DOCS.rglob("*.rst"): + lines = path.read_text(encoding="utf-8").splitlines() + for index in range(1, len(lines)): + line, previous = lines[index].strip(), lines[index - 1].rstrip() + if (len(line) >= 2 and len(set(line)) == 1 and line[0] in "-=~^" + and previous and not previous.startswith((".. ", "* ", " ")) + and len(line) < width(previous)): + short.append(f"{path.name}:{index + 1}") + assert not short, f"title underline too short: {short[:8]}"