Wuzzy/minetest_doc_example
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some spelling mistakes

Browse Source
This commit is contained in:
Wuzzy 2016-12-20 18:25:17 +01:00
parent da00b105a5
commit a5797ab010
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc.lua
View File

@ -3,7 +3,7 @@ Reminder This mod is the core of the Help modpack. It is thus rather low-level.
Use this to add your very own categories and entries. Use this to add your very own categories and entries.
This example demonstrates how to add categories and how to add entries into them. This example demonstrates how to add categories and how to add entries into them.
It also demonstrates the versality of the very important `build_formspec` field of It also demonstrates the versatility of the very important `build_formspec` field of
categories. categories.
]] ]]
@ -81,7 +81,7 @@ doc.new_category("example2", {
--[[ Sorting example ]] --[[ Sorting example ]]
--[[ The entry data includes population as a number. This means we could (if we --[[ The entry data includes population as a number. This means we could (if we
want to) define a custom sorting functin. This affects the order of the entries. want to) define a custom sorting function. This affects the order of the entries.
It makes sure that in the list of entries, the city with the highest population It makes sure that in the list of entries, the city with the highest population
comes first. Custom sorting is entirely optional but it might make it easier comes first. Custom sorting is entirely optional but it might make it easier
for the user to navigate. But note that the default alphabetical sorting is for the user to navigate. But note that the default alphabetical sorting is
@ -120,7 +120,7 @@ doc.new_entry("example2", "tripoli", {
and even interact with them ]] and even interact with them ]]
doc.new_category("example3", { doc.new_category("example3", {
name="Example: Formspec", name="Example: Formspec",
description="Example category for manual freeform formspec entries", description="Example category for manual free-form formspec entries",
--[[ This is a built-in formspec builder. In this case, the entry data --[[ This is a built-in formspec builder. In this case, the entry data
is expected to contains the full formspec definition for any entry. is expected to contains the full formspec definition for any entry.
This is useful if you want to build every entry by hand. The downside This is useful if you want to build every entry by hand. The downside
@ -128,7 +128,7 @@ doc.new_category("example3", {
build_formspec = doc.entry_builders.formspec, build_formspec = doc.entry_builders.formspec,
--[[ Sorting example ]] --[[ Sorting example ]]
--[[ This demonstates the custom sorting type. In the entry list, the --[[ This demonstrates the custom sorting type. In the entry list, the
entries will appear in the exact order as specified. ]] entries will appear in the exact order as specified. ]]
sorting = "custom", sorting = "custom",
sorting_data = { "simple", "widgets", "testbutton" }, sorting_data = { "simple", "widgets", "testbutton" },

10
doc_items.lua
View File

@ -6,7 +6,7 @@ other frequently-used features of doc_items.
--[[ IMPORTANT REMINDER: doc_items mod will automatically generate help --[[ IMPORTANT REMINDER: doc_items mod will automatically generate help
entries for all items (a few exceptions apply) without your intervention. entries for all items (a few exceptions apply) without your intervention.
doc_items already extracts a lot of item definition automatically. doc_items already extracts a lot of item definition automatically.
The API is mainly concernd about enhancing the existing item entries. The API is mainly concerned about enhancing the existing item entries.
Hint: When using this example, use the `/help_reveal` Hint: When using this example, use the `/help_reveal`
chat command to reveal all item entries (for testing) ]] chat command to reveal all item entries (for testing) ]]
@ -84,7 +84,7 @@ information on a single entry. If you do this, you also have to register
aliases since the lookup tool will stop working on nodes with suppressed aliases since the lookup tool will stop working on nodes with suppressed
entries. Suppressing entries may also be useful to combine large lists entries. Suppressing entries may also be useful to combine large lists
of similar items, but be careful not to overdo it and throw away of similar items, but be careful not to overdo it and throw away
potentionally valuable information in the process. potentially valuable information in the process.
The following code shows two nodes which changes its textures when punched. The following code shows two nodes which changes its textures when punched.
For the player, doc_example:node2 is basically the same as doc_example:node1, For the player, doc_example:node2 is basically the same as doc_example:node1,
@ -106,8 +106,8 @@ minetest.register_node("doc_example:node2", {
description = "doc_example test node", description = "doc_example test node",
-- Suppresses the entry -- Suppresses the entry
_doc_items_create_entry = false, _doc_items_create_entry = false,
-- Note that we also do not add _doc_items_longdesc or similar fields, --[[ Because the entry is suppressed, we do not need to add other _doc_items_*
-- since these fiel fields; they would be ignored anyway. ]]
tiles = {"doc_example_2.png"}, tiles = {"doc_example_2.png"},
on_rightclick = function(pos, node, clicker, itemstack, pointed_thing) on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
minetest.set_node(pos, {name="doc_example:node1"}) minetest.set_node(pos, {name="doc_example:node1"})
@ -118,7 +118,7 @@ minetest.register_node("doc_example:node2", {
--[[ Register an alias to make sure the lookup tool still works. --[[ Register an alias to make sure the lookup tool still works.
If this is NOT done, the lookup tool will fail when it is If this is NOT done, the lookup tool will fail when it is
sed on doc_example:node2. ]] used on doc_example:node2. ]]
doc.add_entry_alias("nodes", "doc_example:node1", "doc_example:node2") doc.add_entry_alias("nodes", "doc_example:node1", "doc_example:node2")
-- Another example of this concept in action be seen in the mod “doc_identifier”. -- Another example of this concept in action be seen in the mod “doc_identifier”.