diff options
author | Wuzzy <almikes@aol.com> | 2016-12-12 12:42:18 +0100 |
---|---|---|
committer | Wuzzy <almikes@aol.com> | 2016-12-12 12:42:18 +0100 |
commit | 26cc48a1b2ceece8759c9c7af03d23dff16b2648 (patch) | |
tree | 216ff8679969902142a780b0c4927e0fb40a6ad8 | |
parent | 8b268b179732abd7e077e3bc578e855cbb8256d8 (diff) |
Rename modpack to “Help”
-rw-r--r-- | API.md | 30 | ||||
-rw-r--r-- | README.md | 7 | ||||
-rw-r--r-- | description.txt | 2 | ||||
-rw-r--r-- | init.lua | 10 | ||||
-rw-r--r-- | locale/de.txt | 8 | ||||
-rw-r--r-- | locale/template.txt | 8 |
6 files changed, 33 insertions, 32 deletions
@@ -1,11 +1,11 @@ -# API documentation for the Documentation System core framework +# API documentation for the Documentation System ## Core concepts As a modder, you are free to write basically about everything and are also -relatively free in the presentation of information. The Documentation -System has no restrictions on content whatsoever. +relatively free in the presentation of information. There are no +restrictions on content whatsoever. ### Categories and entries -In the documentation system, everything is built on categories and entries. +In the Documentation System, everything is built on categories and entries. An entry is a single piece of documentation and is the basis of all actual documentation. Categories group multiple entries of the same topic together. @@ -75,7 +75,7 @@ These functions are available: * `doc.set_category_order`: Sets the order of categories in the category list * `doc.show_entry`: Shows a particular entry to a player * `doc.show_category`: Shows the entry list of a category to a player -* `doc.show_doc`: Opens the main Documentation System form for a player +* `doc.show_doc`: Opens the main help form for a player * `doc.get_category_definition`: Returns the definition table of a category * `doc.get_entry_definition`: Returns the definition table of an entry * `doc.entry_exists`: Checks whether an entry exists @@ -167,14 +167,14 @@ following predefined convenience functions: ##### Formspec restrictions When building your formspec, you have to respect the size limitations. -The documentation system uses a size of 12×9 and you must make sure +The help form uses a size of 12×9 and you must make sure all entry widgets are inside a boundary box. The remaining space is -reserved for widgets of the Documentation System and should not be used -to avoid overlapping. +reserved for widgets of the help form and should not be used to avoid +overlapping. Read from the following variables to calculate the final formspec coordinates: -* `doc.FORMSPEC.WIDTH`: Width of Documentation System formspec -* `doc.FORMSPEC.HEIGHT`: Height of Documentation System formspec +* `doc.FORMSPEC.WIDTH`: Width of help formspec +* `doc.FORMSPEC.HEIGHT`: Height of help formspec * `doc.FORMSPEC.ENTRY_START_X`: Leftmost X point of bounding box * `doc.FORMSPEC.ENTRY_START_Y`: Topmost Y point of bounding box * `doc.FORMSPEC.ENTRY_END_X`: Rightmost X point of bounding box @@ -214,9 +214,9 @@ the category definition. ### `doc.set_category_order(category_list)` Sets the order of categories in the category list. -The Documentation System starts with this default order: +The help starts with this default order: - {"basics", "online", "nodes", "tools", "craftitems"} + {"basics", "nodes", "tools", "craftitems", "advanced"} This function can be called at any time, but it recommended to only call this function once for the entire server session and to only call it @@ -230,13 +230,13 @@ second time by any mod, a warning is written into the log. ### `doc.show_doc(playername)` -Opens the main documentation formspec for the player (“Category list” tab). +Opens the main help formspec for the player (“Category list” tab). #### Parameters * `playername`: Name of the player to show the formspec to ### `doc.show_category(playername, category_id)` -Opens the documentation formspec for the player at the specified category +Opens the help formspec for the player at the specified category (“Entry list” tab). #### Parameters @@ -244,7 +244,7 @@ Opens the documentation formspec for the player at the specified category * `category_id`: Category identifier of the selected category ### `doc.show_entry(playername, category_id, entry_id, ignore_hidden)` -Opens the documentation formspec for the player showing the specified entry +Opens the help formspec for the player showing the specified entry of a category (“Entry” tab). If the entry is hidden, an error message is displayed unless `ignore_hidden==true`. @@ -1,7 +1,8 @@ -# Documentation System +# Documentation System [`doc`] This mod provides a simple and highly extensible form in which the user can access help pages about various things and the modder can add those pages. The mod itself does not provide any help texts, just the framework. +It is the heart of the Help modpack, on which the other Help mods depend. Current version: 0.10.0 @@ -13,7 +14,7 @@ To open the help, there are multiple ways: - If you use Unified Inventory or Minetest Game, you will find an extra button in the inventory -The documentation system itself should be more or less self-explanatory. +The help itself should be more or less self-explanatory. This mod is useless on its own, you will only need this mod as a dependency for mods which actually add some help entries. @@ -29,7 +30,7 @@ Players with the `doc_reveal` privilege can use the `/doc_reveal` chat command to reveal all hidden entries instantly. ## For modders and subgame authors -This mod helps you in writing extensive documentation for your mod or subgame. +This mod helps you in writing extensive help for your mod or subgame. You can write about basically anything in the presentation you prefer. To get started, read `API.md` in the directory of this mod. diff --git a/description.txt b/description.txt index 0633964..808a218 100644 --- a/description.txt +++ b/description.txt @@ -1 +1 @@ -A simple in-game documentation system (framework only, the actual help topics are added in other mods). +A simple in-game documentation system which enables mods to add help entries based on templates. @@ -37,7 +37,7 @@ doc.FORMSPEC.ENTRY_HEIGHT = doc.FORMSPEC.ENTRY_END_Y - doc.FORMSPEC.ENTRY_START_ --TODO: Use container formspec element later -- Internal helper variables -local DOC_INTRO = string.format(S("This is the Documentation System, Version %s."), doc.VERSION.STRING) +local DOC_INTRO = S("This is the help.") local CATEGORYFIELDSIZE = { WIDTH = 4, @@ -746,7 +746,7 @@ function doc.formspec_error_no_categories() minetest.formspec_escape( DOC_INTRO .. "\n\n" .. S("Error: No help available.") .. "\n\n" .. -S("No categories have been registered, but the Documentation System is useless without them.\nThe main Documentation System mod (doc) does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again.")) .. "\n\n" .. +S("No categories have been registered, but they are required to provide help.\nThe Documentation System [doc] does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again.")) .. "\n\n" .. S("Recommended mods: doc_basics, doc_items, doc_identifier.") formstring = formstring .. ";]button_exit[3,5;2,1;okay;"..F("OK").."]" return formstring @@ -1135,7 +1135,7 @@ minetest.register_on_player_receive_fields(doc.process_form) minetest.register_chatcommand("doc", { params = "", - description = S("Open documentation system"), + description = S("Open help"), privs = {}, func = function(playername, param) doc.show_doc(playername) @@ -1206,7 +1206,7 @@ if minetest.get_modpath("unified_inventory") ~= nil then unified_inventory.register_button("doc", { type = "image", image = "doc_button_icon_hires.png", - tooltip = S("Documentation System"), + tooltip = S("Help"), action = button_action, }) end @@ -1216,7 +1216,7 @@ if minetest.get_modpath("sfinv_buttons") ~= nil then sfinv_buttons.register_button("doc", { image = "doc_button_icon_lores.png", tooltip = S("Collection of help texts"), - title = S("Documentation System"), + title = S("Help"), action = button_action, }) end diff --git a/locale/de.txt b/locale/de.txt index 2ad8ff2..082f329 100644 --- a/locale/de.txt +++ b/locale/de.txt @@ -6,7 +6,7 @@ All help entries unlocked! = Alle Hilfseinträge freigeschaltet! Allows you to reveal all hidden help entries with /doc_reveal = Ermöglicht es Ihnen, alle verborgenen Hilfseinträge mit /doc_reveal freizuschalten Category list = Kategorienliste Currently all entries in this category are hidden from you.\nUnlock new entries by proceeding in the game. = Momentan sind alle Einträge in dieser Kategorie vor Ihnen verborgen.\nSchalten Sie neue Einträge frei, indem Sie im Spiel fortschreiten. -Documentation System = Dokumentationssystem +Help = Hilfe Entry = Eintrag Entry list = Eintragsliste Error: Access denied. = Fehler: Zugriff verweigert. @@ -20,10 +20,10 @@ Help > %s > (No Entry) = Hilfe > %s > (Kein Eintrag) Hidden entries: %d = Verborgene Einträge: %d New entries: %d = Neue Einträge: %d New help entry unlocked: %s > %s = Neuen Hilfseinträg freigeschaltet: %s > %s -No categories have been registered, but the Documentation System is useless without them.\nThe main Documentation System mod (doc) does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again. = Es wurden keine Kategorien registriert, aber ohne sie is das Dokumentationssystem nutzlos.\nDie Hauptmod des Dokumentationssystems (doc) bringt selbst keine Hilfsinhalte mit, sie benötigt zusätzliche Mods, um Hilfsinhalte hinzuzufügen. Bitte stellen Sie sicher, dass solche Mods für diese Welt aktiviert sind, und versuchen Sie es erneut. +No categories have been registered, but they are required to provide help.\nThe Documentation System [doc] does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again. = Es wurden keine Kategorien registriert, aber sie werden benötigt, um die Hilfe anbieten zu können.\nDas Dokumentationssystem [doc] bringt von sich aus keine eigenen Hilfsinhalte mit, es benötigt zusätzliche Mods, um sie hinzuzufügen. Bitte stellen Sie sicher, dass solche Mods für diese Welt aktiviert sind und versuchen Sie es erneut. Number of entries: %d = Anzahl der Einträge: %d OK = OK -Open documentation system = Dokumentationssystem öffnen +Open help = Hilfe öffnen Please select a category you wish to learn more about: = Bitte wählen Sie eine Kategorie, über die Sie mehr erfahren möchten, aus: Recommended mods: doc_basics, doc_items, doc_identifier. = Empfohlene Mods: doc_basics, doc_items, doc_identifier. Reveals all hidden help entries to you = Schaltet für Sie alle verborgenen Hilfseinträge frei @@ -34,7 +34,7 @@ Show previous entry = Vorherigen Eintrag zeigen This category does not have any entries. = Diese Kategorie hat keine Einträge. This category has the following entries: = Diese Kategorie hat die folgenden Einträge: This category is empty. = Diese Kategorie ist leer. -This is the Documentation System, Version %s. = Dies ist das Dokumentationssystem, Version %s. +This is the help. = Dies ist die Hilfe. You haven't chosen a category yet. Please choose one in the category list first. = Sie haben noch keine Kategorie gewählt. Bitte wählen Sie zuerst eine Kategorie in der Kategorienliste aus. You haven't chosen an entry yet. Please choose one in the entry list first. = Sie haben noch keinen Eintrag gewählt. Bitte wählen Sie zuerst einen Eintrag in der Eintragsliste aus. Nameless entry (%s) = Namenloser Eintrag (%s) diff --git a/locale/template.txt b/locale/template.txt index a20f982..7e0a267 100644 --- a/locale/template.txt +++ b/locale/template.txt @@ -6,7 +6,7 @@ All help entries unlocked! = Allows you to reveal all hidden help entries with /doc_reveal = Category list = Currently all entries in this category are hidden from you.\\nUnlock new entries by proceeding in the game. = -Documentation System = +Help = Entry = Entry list = Error: Access denied. = @@ -21,10 +21,10 @@ Hidden entries: %d = Nameless entry (%s) = New entries: %d = New help entry unlocked: %s > %s = -No categories have been registered, but the Documentation System is useless without them.\nThe main Documentation System mod (doc) does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again. = +No categories have been registered, but they are required to provide help.\nThe Documentation System [doc] does not come with help contents on its own, it needs additional mods to add help content. Please make sure such mods are enabled on for this world, and try again. = Number of entries: %d = OK = -Open documentation system = +Open help = Please select a category you wish to learn more about: = Recommended mods: doc_basics, doc_items, doc_identifier. = Reveals all hidden help entries to you = @@ -35,7 +35,7 @@ Show previous entry = This category does not have any entries. = This category has the following entries: = This category is empty. = -This is the Documentation System, Version %s. = +This is the help. = You haven't chosen a category yet. Please choose one in the category list first. = You haven't chosen an entry yet. Please choose one in the entry list first. = Collection of help texts = |