TiddlyWiki · linonetwo · Jul 27, 2024 · Jul 27, 2024 · Jul 27, 2024 · Jul 27, 2024
diff --git a/boot/boot.js b/boot/boot.js
diff --git a/core/modules/utils/plugin-translation.js b/core/modules/utils/plugin-translation.js
@@ -0,0 +1,58 @@
+/*\
+title: $:/core/modules/utils/plugin-translation.js
+type: application/javascript
+module-type: utils
+
+Move active translations from a plugin's `/languages` path to the `/language` path.
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+exports.activatePluginTranslations = function(shadowTiddlers,pluginTitle,constituentTiddlers) {
+	// Define the source and target namespaces
+	var sourceNamespace = pluginTitle + "/languages/";
+	var targetNamespace = pluginTitle + "/language/";
+	// Function to extract tiddlers from a source namespace to the target namespace
+	function extractTiddlers(sourcePath) {
+		$tw.utils.each(constituentTiddlers,function(tiddler) {
+			if($tw.utils.startsWith(tiddler.title,sourcePath)) {
+				var newTitle = tiddler.title.replace(sourcePath, targetNamespace);
+				shadowTiddlers[newTitle] = {
+					source: pluginTitle,
+					tiddler: new $tw.Tiddler(tiddler,{title: newTitle})
+				};
+			}
+		});
+	}
+
+	// Extract fallback language tiddlers (en-GB) from the sourceNamespace
+	extractTiddlers(sourceNamespace + "en-GB/");
+
+	// Check the $:/language tiddler
+	var selectedLanguagePlugin = $tw.wiki.getTiddlerText("$:/language");
+
+	// Resolve dependents and extract them in reverse order
+	function resolveDependents(languagePluginTitle) {
+		var languagePlugin = $tw.wiki.getTiddler(languagePluginTitle);
+		if(languagePlugin) {
+			var dependents = $tw.utils.parseStringArray(languagePlugin.fields.dependents || "");
+			$tw.utils.each(dependents,function(dependent) {
+				// Resolve dependents for the selected language, extract as fallback
+				resolveDependents(dependent);
+				// Extract translation tiddlers for the selected language
+				extractTiddlers(sourceNamespace + dependent.replace("$:/languages/","") + "/");
+			});
+		}
+	}
+
+	if(selectedLanguagePlugin) {
+		resolveDependents(selectedLanguagePlugin);
+		extractTiddlers(sourceNamespace + selectedLanguagePlugin.replace("$:/languages/","") + "/");
+	}
+};
+
+})();
diff --git a/editions/tw5.com/tiddlers/macros/LingoMacro.tid b/editions/tw5.com/tiddlers/macros/LingoMacro.tid
@@ -1,16 +1,35 @@
+caption: lingo
 created: 20150221154907000
-modified: 20150221155706000
-title: lingo Macro
+modified: 20231028123405895
 tags: Macros [[Core Macros]]
-caption: lingo
+title: lingo Macro
+type: text/vnd.tiddlywiki
 
 The <<.def lingo>> [[macro|Macros]] relates to the translation of ~TiddlyWiki's user interface into other languages. It returns a piece of text in the user's currently selected language.
 
-Translatable text is supplied by language plugins containing tiddlers with specific titles that start with `$:/language/`.
+Translatable text, aka l10n (localization), is supplied by：
 
-!! Parameters
+# Language plugins
+# Tiddlers under any plugins's `languages/` path
+
+!! Language plugins
+
+You can directly pass title to `lingo` macro, when there is a language plugin containing a tiddler with such title that start with `$:/language/`. 
 
 ;title
 : The title of the shadow tiddler that contains the text. The prefix `$:/language/` is added automatically
 
-<<.macro-examples "lingo">>
+<<.macro-examples "lingo (for language plugin)">>
+
+!! Plugins
+
+When writing a plugin, you can place translatable text in tiddlers under the `$:/plugins/xxx/yyy/languages/` path of your plugin. During wiki boot they are automatically moved to `$:/plugins/xxx/yyy/language/` path, so lingo macro can use `$:/plugins/xxx/yyy/language/` as base path to get the translation.
+
+!! Parameters
+
+;key
+: The last part of title of the tiddler that contains the text. The `<<lingo-base>>` prefix and current language name prefix is added automatically
+
+<<.macro-examples "lingo (for custom base)">>
+
+{{lingo Macro (file structure)}}
diff --git a/editions/tw5.com/tiddlers/macros/examples/lingo Macro (custom plugin examples).tid b/editions/tw5.com/tiddlers/macros/examples/lingo Macro (custom plugin examples).tid
@@ -0,0 +1,21 @@
+created: 20231028120432257
+modified: 20240206113509050
+tags: [[lingo Macro]] [[Macro Examples]]
+title: lingo (for custom plugin) Macro (Examples)
+type: text/vnd.tiddlywiki
+
+\define lingo-base() $:/plugins/tiddlywiki/menubar/language/
+
+Given the `\define lingo-base() $:/plugins/tiddlywiki/menubar/language/`, this example shows the localizaion key `Config/MenuItems/Heading` being translate to the text in [[$:/plugins/tiddlywiki/menubar/language/en-GB/Config/MenuItems/Heading]]:
+
+<$macrocall $name=".example" n="1" eg="""<<lingo Config/MenuItems/Heading>>"""/>
+
+This example shows the `lingo-base` can be prepend to the key, and do a transclusion:
+
+<$macrocall $name=".example" n="2" eg="""{{$:/plugins/tiddlywiki/menubar/language/Config/MenuItems/Heading}}"""/>
+
+When use lingo macro in a [[Inline Mode WikiText]] like [[list|Lists in WikiText]] or [[title|Headings in WikiText]], the parse mode will be inline, so translated text will be inlined too.
+
+<$macrocall $name=".example" n="3" eg="""# <<lingo Config/MenuItems/Heading>>"""/>
+
+<$macrocall $name=".example" n="4" eg="""!! <<lingo Config/MenuItems/Heading>>"""/>
diff --git a/editions/tw5.com/tiddlers/macros/examples/lingo Macro (file structure).tid b/editions/tw5.com/tiddlers/macros/examples/lingo Macro (file structure).tid
@@ -0,0 +1,75 @@
+created: 20231028120432257
+modified: 20240206122408606
+tags: [[lingo Macro]] [[Macro Examples]]
+title: lingo Macro (file structure)
+
+!! Example file structure for [[TiddlyWiki on Node.js]]
+
+!!! Suggested file structure
+
+When developing a plugin, you may want to organize your language files like this on the file system as [[MultiTiddlerFiles]]:
+
+```tree
+├── languages
+│   ├── en-GB
+│   │   ├── Translations.multids
+│   │   └── SomeLongText.tid
+│   └── zh-Hans
+│       ├── Translations.multids
+│       └── SomeLongText.tid
+├── other files
+└── plugin.info
+```
+
+See [[$:/plugins/tiddlywiki/menubar/tree]] for an example.
+
+!!! Define Multiple Translations in One Tiddler
+
+And the content of `languages/en-GB/Translations.multids` may looks like this:
+
+```multids
+title: $:/plugins/yourName/pluginName/languages/en-GB/
+
+OpenInteractiveCard: Open Interactive Card
+OpenStaticCard: Open Static Card
+```
+
+Later you can use it like:
+
+```tid
+title: someTiddler
+caption: {{$:/plugins/yourName/pluginName/language/OpenStaticCard}}
+
+\procedure lingo-base() $:/plugins/yourName/pluginName/language/
+\whitespace trim
+
+<<lingo OpenInteractiveCard>>
+```
+
+Note that you write the translations under `/languages/` with "s", but use `/language/` without "s" in the `lingo-base`. Because TiddlyWiki automatically moves the active translations to `/language/` without "s" when it loads the plugin.
+
+!!! Define Long Text in a regular Tiddler
+
+You can also use a regular tiddler for long text, like `SomeLongText.tid` in the example above, to store a multi-paragraph long text:
+
+```tid
+title: $:/plugins/yourName/pluginName/languages/en-GB/SomeLongText
+
+!!! SubTitle
+
+This is a long text.
+```
+
+Later you can use it like:
+
+```tid
+title: someTiddler
+
+\procedure lingo-base() $:/plugins/yourName/pluginName/language/
+
+!! <<lingo OpenInteractiveCard>>
+
+<<lingo SomeLongText>>
+```
+
+Note that lingo macro will use the [[parse mode|WikiText Parser Modes]] in the current position where this procedure is invoked.
diff --git a/...w5.com/tiddlers/macros/examples/lingo.tid → ...ingo Macro (language plugin examples).tid b/...w5.com/tiddlers/macros/examples/lingo.tid → ...ingo Macro (language plugin examples).tid
@@ -1,7 +1,7 @@
 created: 20150221151358000
 modified: 20150221160113000
 tags: [[lingo Macro]] [[Macro Examples]]
-title: lingo Macro (Examples)
+title: lingo (for official language plugin) Macro (Examples)
 type: text/vnd.tiddlywiki
 
 This example shows the text used as the basis for the title of a newly created tiddler:

diff --git a/plugins/tiddlywiki/menubar/config.tid b/plugins/tiddlywiki/menubar/config.tid
@@ -3,12 +3,13 @@ tags: $:/tags/ControlPanel/Toolbars
 caption: Menu Bar
 
 \define config-base() $:/config/plugins/menubar/MenuItems/Visibility/
+\define lingo-base() $:/plugins/tiddlywiki/menubar/language/
 
-! Menu Bar Configuration
+! <<lingo Config/Heading1>>
 
-!! Menu Items
+!! <<lingo Config/MenuItems/Heading>>
 
-Select which menu items will be shown. You can also drag items to reorder them.
+<<lingo Config/MenuItems/Description>>
 
 <$set name="tv-config-toolbar-icons" value="yes">
 
@@ -20,18 +21,18 @@ Select which menu items will be shown. You can also drag items to reorder them.
 
 </$set>
 
-!! Breakpoint Position
+!! <<lingo Config/BreakpointPosition/Heading>>
 
-The breakpoint position between narrow and wide screens. Should include CSS units (eg. `400px`).
+<<lingo Config/BreakpointPosition/Description>>
 
 <$edit-text tiddler="$:/config/plugins/menubar/breakpoint" default="" tag="input"/>
 
-!! Contents Tag
+!! <<lingo Config/ContentsTag/Heading>>
 
-The tag for the ~TableOfContents used in the Contents dropdown
+<<lingo Config/ContentsTag/Description>>
 
 <$edit-text tiddler="$:/config/plugins/menubar/TableOfContents/Tag" default="" tag="input"/>
 
-!! Menu Bar Colours
+!! <<lingo Config/MenuBarColours/Heading>>
 
-To change the colour of the menu bar, define the colours `menubar-foreground` and `menubar-background` in the currently selected palette
+<<lingo Config/MenuBarColours/Description>>
diff --git a/plugins/tiddlywiki/menubar/items/contents.tid b/plugins/tiddlywiki/menubar/items/contents.tid
@@ -1,6 +1,6 @@
 title: $:/plugins/tiddlywiki/menubar/items/contents
-caption: Contents
-description: Table of Contents
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/TOC/Name}}
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/TOC/Description}}
 is-dropdown: yes
 tags: $:/tags/MenuBar
 

diff --git a/plugins/tiddlywiki/menubar/items/hamburger.tid b/plugins/tiddlywiki/menubar/items/hamburger.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/hamburger
 tags: $:/tags/MenuBar
-caption: Hamburger
-description: Show the full menu bar on a narrow screen
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/Hamburger/Name}}
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/Hamburger/Description}}
 custom-menu-content: {{$:/plugins/tiddlywiki/menubar/items/hamburger}}
 show-when: narrow
 

diff --git a/plugins/tiddlywiki/menubar/items/pagecontrols.tid b/plugins/tiddlywiki/menubar/items/pagecontrols.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/pagecontrols
 tags: $:/tags/MenuBar
-description: Page controls from the sidebar
-caption: Page controls
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/PageControls/Name}}
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/PageControls/Name}}
 custom-menu-content: <$transclude tiddler="$:/plugins/tiddlywiki/menubar/items/pagecontrols" mode="inline"/>
 
 \whitespace trim

diff --git a/plugins/tiddlywiki/menubar/items/search.tid b/plugins/tiddlywiki/menubar/items/search.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/search
 custom-menu-content: {{$:/plugins/tiddlywiki/menubar/items/search}}
-description: Search
-caption: Search
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/Search/Name}}
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/Search/Name}}
 tags: $:/tags/MenuBar
 
 \define cancel-search-actions()

diff --git a/plugins/tiddlywiki/menubar/items/server.tid b/plugins/tiddlywiki/menubar/items/server.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/server
 tags: $:/tags/MenuBar
-description: Server options
-caption: Server
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/Server/Description}}
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/Server/Name}}
 custom-menu-content: <$transclude tiddler="$:/plugins/tiddlywiki/menubar/items/server" mode="inline"/>
 
 <$list filter="[[$:/status/IsLoggedIn]get[text]else[no]match[yes]]" variable="ignore">

diff --git a/plugins/tiddlywiki/menubar/items/sidebar.tid b/plugins/tiddlywiki/menubar/items/sidebar.tid
@@ -1,6 +1,6 @@
 title: $:/plugins/tiddlywiki/menubar/items/sidebar
-caption: Sidebar
-description: Sidebar
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/Sidebar/Name}}
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/Sidebar/Name}}
 is-dropdown: yes
 tags: $:/tags/MenuBar
 

diff --git a/plugins/tiddlywiki/menubar/items/topleftbar.tid b/plugins/tiddlywiki/menubar/items/topleftbar.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/topleftbar
 tags: $:/tags/MenuBar
-description: Items from $:/tags/TopLeftBar
-caption: Legacy Top Left Bar
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/TopLeftBar/Description}}
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/TopLeftBar/Name}}
 custom-menu-content: <$transclude tiddler="$:/plugins/tiddlywiki/menubar/items/topleftbar" mode="inline"/>
 
 <$list filter="[all[shadows+tiddlers]tag[$:/tags/TopLeftBar]!has[draft.of]]" variable="listItem" storyview="pop">

diff --git a/plugins/tiddlywiki/menubar/items/toprightbar.tid b/plugins/tiddlywiki/menubar/items/toprightbar.tid
@@ -1,7 +1,7 @@
 title: $:/plugins/tiddlywiki/menubar/items/toprightbar
 tags: $:/tags/MenuBar
-description: Items from $:/tags/TopRightBar
-caption: Legacy Top Right Bar
+description: {{$:/plugins/tiddlywiki/menubar/language/Items/TopRightBar/Description}}
+caption: {{$:/plugins/tiddlywiki/menubar/language/Items/TopRightBar/Name}}
 custom-menu-content: <$transclude tiddler="$:/plugins/tiddlywiki/menubar/items/toprightbar" mode="inline"/>
 custom-menu-styles-wide: float: right;
 

diff --git a/plugins/tiddlywiki/menubar/language/de-DE/Translations.multids b/plugins/tiddlywiki/menubar/language/de-DE/Translations.multids
@@ -0,0 +1,25 @@
+title: $:/plugins/tiddlywiki/menubar/languages/de-DE/
+
+Config/Heading1: Konfiguration
+Config/MenuItems/Heading: Top Menü Elemente
+Config/MenuItems/Description: Wähle alle Elemente, die angezeigt werden sollen. Drag and Drop kann zum sortieren verwendet werden.
+Config/BreakpointPosition/Heading: Breakpoint Position
+Config/BreakpointPosition/Description: Diese Einstellung schaltet zwischen breiten bzw. schmalen Displays um. CSS Einheiten werden benötigt - zB: `400px`.
+Config/ContentsTag/Heading: Inhaltsverzeichnis Tag
+Config/ContentsTag/Description: Tag, der für das Inhaltsverzeichnis verwendet wird.
+Config/MenuBarColours/Heading: Menü Farben
+Config/MenuBarColours/Description: Farben können mit `menubar-foreground` und `menubar-background` in der aktuellen Palette: {{$:/palette}} definiert werden.
+Items/TOC/Name: Inhalt
+Items/TOC/Description: Inhaltsverzeichnis
+Items/Hamburger/Name: Menü Icon
+Items/Hamburger/Description: Bei einem schmalen Bildschirm wird ein Menü-Icon angezeigt.
+Items/PageControls/Name: Page controls
+Items/PageControls/Description: Page controls from the sidebar.
+Items/Search/Name: Suche
+Items/Server/Name: Server
+Items/Server/Description: Server Optionen.
+Items/Sidebar/Name: Sidebar
+Items/TopLeftBar/Name: Legacy Top Left Bar
+Items/TopLeftBar/Description: Elemente von $:/tags/TopLeftBar
+Items/TopRightBar/Name: Legacy Top Right Bar
+Items/TopRightBar/Description: Elemente von $:/tags/TopRightBar