diff --git a/Docs/fungus_docs/about.md b/Docs/fungus_docs/about_fungus.md similarity index 99% rename from Docs/fungus_docs/about.md rename to Docs/fungus_docs/about_fungus.md index 7cdb70e8..a21d7ff3 100644 --- a/Docs/fungus_docs/about.md +++ b/Docs/fungus_docs/about_fungus.md @@ -1,4 +1,4 @@ -# About %Fungus {#about} +# About %Fungus # {#about_fungus} [TOC] # What is Fungus? # {#what_is_fungus} diff --git a/Docs/fungus_docs/conduct.md b/Docs/fungus_docs/code_of_conduct.md similarity index 100% rename from Docs/fungus_docs/conduct.md rename to Docs/fungus_docs/code_of_conduct.md diff --git a/Docs/fungus_docs/articles.md b/Docs/fungus_docs/community_tutorials.md similarity index 97% rename from Docs/fungus_docs/articles.md rename to Docs/fungus_docs/community_tutorials.md index ea50f36d..451fe1e2 100644 --- a/Docs/fungus_docs/articles.md +++ b/Docs/fungus_docs/community_tutorials.md @@ -1,4 +1,4 @@ -# Community Articles # {#articles} +# Community tutorials # {#community_tutorials} [TOC] If you've created an article or video about %Fungus let us know on the forum and we'll add it here. diff --git a/Docs/fungus_docs/conversation.md b/Docs/fungus_docs/conversation_system.md similarity index 98% rename from Docs/fungus_docs/conversation.md rename to Docs/fungus_docs/conversation_system.md index 34787992..65df4f0a 100644 --- a/Docs/fungus_docs/conversation.md +++ b/Docs/fungus_docs/conversation_system.md @@ -1,4 +1,4 @@ -# Conversation system # {#conversation} +# Conversation system # {#conversation_system} [TOC] The Say and Portrait commands are a powerful way to build character dialogue, but it can be tedious to add large amounts of dialogue this way. diff --git a/Docs/fungus_docs/glossary.md b/Docs/fungus_docs/glossary.md index 1294cabf..f611c395 100644 --- a/Docs/fungus_docs/glossary.md +++ b/Docs/fungus_docs/glossary.md @@ -1,4 +1,4 @@ -# Glossary of terms {#glossary} +# Glossary {#glossary} diff --git a/Docs/fungus_docs/install.md b/Docs/fungus_docs/installation.md similarity index 98% rename from Docs/fungus_docs/install.md rename to Docs/fungus_docs/installation.md index abe6982a..dd1536b2 100644 --- a/Docs/fungus_docs/install.md +++ b/Docs/fungus_docs/installation.md @@ -1,4 +1,4 @@ -# Installation # {#install} +# Installation # {#installation} [TOC] This page explains how to download and install Unity and %Fungus. diff --git a/Docs/fungus_docs/narrative_parser_tokens.md b/Docs/fungus_docs/narrative_text_tags.md similarity index 96% rename from Docs/fungus_docs/narrative_parser_tokens.md rename to Docs/fungus_docs/narrative_text_tags.md index a0b25c51..6af1ded8 100644 --- a/Docs/fungus_docs/narrative_parser_tokens.md +++ b/Docs/fungus_docs/narrative_text_tags.md @@ -1,4 +1,4 @@ -# Narrative Parser Tags # {#narrative_tags} +# Narrative Text Tags # {#narrative_text_tags} The following tokens can be used within Story Text to do things such as change the styling of text or clear the contents of a dialog area on input and much more. You can see this list in the editor by pressing the Tag Help button in the Say command. diff --git a/Docs/fungus_lua.md b/Docs/fungus_lua.md index 01361e0c..e907be81 100644 --- a/Docs/fungus_lua.md +++ b/Docs/fungus_lua.md @@ -2,7 +2,7 @@ FungusLua is a simple way to embed Lua scripting into your Unity project. Lua is an easy to learn scripting language so it's a great way to empower artists, writers and designers to use more of the power of Unity. -* @subpage lua_overview +* @subpage lua_about_funguslua * @subpage lua_create_menu * @subpage lua_environment * @subpage lua_bindings @@ -10,7 +10,7 @@ FungusLua is a simple way to embed Lua scripting into your Unity project. Lua is * @subpage lua_utils * @subpage lua_fungus_module * @subpage lua_controlling_fungus -* @subpage execute_lua +* @subpage lua_execute_lua * @subpage lua_preferences * @subpage lua_store * @subpage lua_string_table diff --git a/Docs/fungus_lua/lua_overview.md b/Docs/fungus_lua/lua_about_fungus_lua.md similarity index 97% rename from Docs/fungus_lua/lua_overview.md rename to Docs/fungus_lua/lua_about_fungus_lua.md index 3ea10491..13436454 100644 --- a/Docs/fungus_lua/lua_overview.md +++ b/Docs/fungus_lua/lua_about_fungus_lua.md @@ -1,4 +1,4 @@ -# What is FungusLua? # {#lua_overview} +# About FungusLua # {#lua_about_funguslua} [TOC] FungusLua is a simple way to embed Lua scripting into your Unity project. Lua is an easy to learn scripting language so it's a great way to empower artists, writers and designers to use more of the power of Unity. diff --git a/Docs/fungus_lua/lua_controlling_fungus.md b/Docs/fungus_lua/lua_controlling_fungus.md index 14fed97a..39f82d75 100644 --- a/Docs/fungus_lua/lua_controlling_fungus.md +++ b/Docs/fungus_lua/lua_controlling_fungus.md @@ -1,4 +1,4 @@ -# Controlling Fungus # {#lua_controlling_fungus} +# Controlling %Fungus # {#lua_controlling_fungus} [TOC] The %Fungus module provides several functions for working with the standard %Fungus narrative features and flowcharts. diff --git a/Docs/fungus_lua/create_menu.md b/Docs/fungus_lua/lua_create_menu.md similarity index 100% rename from Docs/fungus_lua/create_menu.md rename to Docs/fungus_lua/lua_create_menu.md diff --git a/Docs/fungus_lua/execute_lua.md b/Docs/fungus_lua/lua_execute_lua.md similarity index 95% rename from Docs/fungus_lua/execute_lua.md rename to Docs/fungus_lua/lua_execute_lua.md index 84c9c8a7..0bdaf31d 100644 --- a/Docs/fungus_lua/execute_lua.md +++ b/Docs/fungus_lua/lua_execute_lua.md @@ -1,4 +1,4 @@ -# ExecuteLua Command # {#execute_lua} +# ExecuteLua Command # {#lua_execute_lua} [TOC] This command allows you to embed a Lua script to be executed as part of a command sequence in a Block. The Lua script to be executed can be specified in the inspector or in a text file, in the same way as the @ref lua_script component. diff --git a/Docs/fungus_lua/lua_fungus_module.md b/Docs/fungus_lua/lua_fungus_module.md index cb6803cf..0389dffa 100644 --- a/Docs/fungus_lua/lua_fungus_module.md +++ b/Docs/fungus_lua/lua_fungus_module.md @@ -1,7 +1,7 @@ -# Fungus Lua Module # {#lua_fungus_module} +# %Fungus Lua Module # {#lua_fungus_module} [TOC] -The Fungus Lua module provides handy functions for working with Lua, Unity and %Fungus. It is located in FungusLua/Resources/Lua/Fungus.txt and is loaded automatically when you use the Lua Script component. +The %Fungus Lua module provides handy functions for working with Lua, Unity and %Fungus. It is located in FungusLua/Resources/Lua/Fungus.txt and is loaded automatically when you use the Lua Script component. In this page we cover some of the more generic functionality in the module, other major features are described elsewhere in the documentation. diff --git a/Docs/fungus_lua/unity_test_tools.md b/Docs/fungus_lua/lua_unity_test_tools.md similarity index 100% rename from Docs/fungus_lua/unity_test_tools.md rename to Docs/fungus_lua/lua_unity_test_tools.md diff --git a/Docs/mainpage.md b/Docs/mainpage.md index 292b75a7..3d292f0b 100644 --- a/Docs/mainpage.md +++ b/Docs/mainpage.md @@ -4,20 +4,20 @@ Welcome to the documentation website for Fungus, the open source visual storytel There's a wide range of training material available here, suitable for both beginner and experienced game developers. -* @subpage about "What is Fungus?" -* @subpage training_course "Fungus Training Course" -* @subpage tutorial_videos "Tutorial videos" -* @subpage install "Installation instructions" +* @subpage about_fungus +* @subpage training_course +* @subpage tutorial_videos +* @subpage installation * @subpage getting_started * @subpage flowcharts * @subpage blocks * @subpage telling_a_story * @subpage playing_audio -* @subpage conversation -* @subpage articles "Community tutorials" -* @subpage narrative_tags +* @subpage conversation_system +* @subpage community_tutorials +* @subpage narrative_text_tags * @subpage glossary -* @subpage faq Frequently Asked Questions +* @subpage faq * @subpage code_of_conduct [community forum]: http://fungusgames.com/forum