Difference between revisions of "Manual:Contents"
Jump to navigation
Jump to search
(→Improving the manual: Repair broken link to forum) |
|||
(30 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
<!--{{Hubs|banner|dev=y|admin=y}}--> | <!--{{Hubs|banner|dev=y|admin=y}}--> | ||
− | [[File: | + | [[File:{{#setmainimage:Mudlet-Manual.png}}|right|175px|Mudlet documentation]] |
− | This is a | + | This is a manual for both Mudlet users and developers on using, or developing, Mudlet. |
− | + | ==Main sections== | |
+ | {| class="MainPageBG" style="width:100%; border:1px solid #c9c07f; background:#fdf7bb; vertical-align:top; color:#000;" | | ||
+ | !- style="width:50%; vertical-align:top; padding-left:2px border:none" | | ||
+ | ==For MUD Players== | ||
+ | !- style="width:50%; vertical-align:top; padding-left:2px border:none" | | ||
− | == | + | ==For Developers== |
− | + | |- | |
− | | style="width:50%; vertical-align:top; border: | + | | style="width:50%; vertical-align:top; border:none" | |
− | |||
; Guide to using Mudlet client. | ; Guide to using Mudlet client. | ||
− | [[Manual:Introduction| | + | [[Manual:Introduction|Introduction to Mudlet]] | [[Manual:Technical Manual|Technical Manual]] | [[Manual:Migrating|Migrating to Mudlet]] |
; Enhancing your Mudlet experience. | ; Enhancing your Mudlet experience. | ||
− | [[Manual:Scripting|Scripting]] | [[Manual:Lua | + | [[Manual:Scripting|Scripting]] | [[Manual:Lua Functions | Lua API and Reference]] | [http://oneymus.github.io/Vyzor/ Vyzor Guide] | [[Manual:Geyser| Geyser Guide]] |
− | + | | style="width:50%; vertical-align:top; border:none" | | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | style="width:50%; vertical-align:top; border: | ||
− | |||
; Architecture | ; Architecture | ||
: An overview of the key parts of Mudlet's source code. | : An overview of the key parts of Mudlet's source code. | ||
− | : [[ | + | : [[Compiling Mudlet | Compiling Mudlet]] | [[Relevant_Developer_Tutorials|Relevant Developer Tutorials]] | [[Manual:Versioning|Versioning strategy]] |
|} | |} | ||
Line 38: | Line 29: | ||
There are multiple ways to browse through the documentation. Readers having trouble finding a particular topic in the section above or the [[#Categories|category]] list may find the following ways of browsing to be helpful. | There are multiple ways to browse through the documentation. Readers having trouble finding a particular topic in the section above or the [[#Categories|category]] list may find the following ways of browsing to be helpful. | ||
* [[Special:Allpages/Manual:]] - An automatically generated list of all pages in the Manual: namespace. | * [[Special:Allpages/Manual:]] - An automatically generated list of all pages in the Manual: namespace. | ||
− | * [[:Category:Manual]] - the top-level Manual category | + | * [[:Category:Mudlet Manual]] - the top-level Manual category |
== Improving the manual == | == Improving the manual == | ||
− | * There are still a lot of holes in this manual! See the [[ | + | * There are still a lot of holes in this manual! See the [[Manual:To do|'to do' page]] for details. |
− | * There is still content on [http://mudlet.git.sourceforge.net/git/gitweb.cgi?p=mudlet/mudlet;a=blob_plain;f=src/mudlet_documentation.html;hb=HEAD The Mudlet Manual] which may need to be migrated. If you can't find information on a particular issue in this documentation, please visit [ | + | * There is still content on [http://mudlet.git.sourceforge.net/git/gitweb.cgi?p=mudlet/mudlet;a=blob_plain;f=src/mudlet_documentation.html;hb=HEAD The Mudlet Manual] which may need to be migrated. If you can't find information on a particular issue in this documentation, please visit [https://forums.mudlet.org/ The Mudlet Forum] and ask your question there and someone will help you. |
* '''[[Project:Manual]]''' is a place to discuss and co-ordinate the development of the Manual: namespace. | * '''[[Project:Manual]]''' is a place to discuss and co-ordinate the development of the Manual: namespace. | ||
* See also [[Project:Current issues]]. | * See also [[Project:Current issues]]. | ||
Line 49: | Line 40: | ||
{{Categories}} | {{Categories}} | ||
+ | |||
+ | {{Mudlet Manual list}} | ||
--> | --> | ||
− | + | [[Category: Mudlet Manual]] |
Revision as of 23:59, 1 August 2018
This is a manual for both Mudlet users and developers on using, or developing, Mudlet.
Main sections
For MUD Players |
For Developers |
---|---|
Introduction to Mudlet | Technical Manual | Migrating to Mudlet
Scripting | Lua API and Reference | Vyzor Guide | Geyser Guide |
|
Others
- Mudlet FAQ
- Frequently asked questions about Mudlet.
Browsing the manual
There are multiple ways to browse through the documentation. Readers having trouble finding a particular topic in the section above or the category list may find the following ways of browsing to be helpful.
- Special:Allpages/Manual: - An automatically generated list of all pages in the Manual: namespace.
- Category:Mudlet Manual - the top-level Manual category
Improving the manual
- There are still a lot of holes in this manual! See the 'to do' page for details.
- There is still content on The Mudlet Manual which may need to be migrated. If you can't find information on a particular issue in this documentation, please visit The Mudlet Forum and ask your question there and someone will help you.
- Project:Manual is a place to discuss and co-ordinate the development of the Manual: namespace.
- See also Project:Current issues.