Difference between revisions of "Manual:Contents"

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

Guide to using Mudlet client.

Introduction to Mudlet | Technical Manual | Migrating to Mudlet

Enhancing your Mudlet experience.

Scripting | Lua API and Reference | Vyzor Guide | Geyser Guide

Architecture: An overview of the key parts of Mudlet's source code.; Compiling Mudlet | Relevant Developer Tutorials | Versioning strategy

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.

@@ Line 1: / Line 1: @@
 <!--{{Hubs|banner|dev=y|admin=y}}-->
-[[File:Mudlet-Manual.png|right|175px|Mudlet documentation]]
+[[File:{{#setmainimage:Mudlet-Manual.png}}|right|175px|Mudlet documentation]]
-This is a '''technical manual for the Mudlet software'''. It contains information for '''developers''' and '''end users''' on '''using''' and '''developing''' for the Mudlet software.
+This is a manual for both Mudlet users and developers on using, or developing, Mudlet.
-<!--This manual is '''not for end users''' of MediaWiki. If you are looking for '''documentation to help you use MediaWiki, read the [[Help:Contents|MediaWiki Handbook]].'''-->
 ==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 End Users==
+==For MUD Players==
 !- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 ==For Developers==
 |-
 | style="width:50%; vertical-align:top; border:none" |
 ; Guide to using Mudlet client.
-[[Manual:Introduction|Introduction to Modern MUD Clients]] | [[Manual:Technical Manual|Technical Manual]] | [[Manual:Migrating|Migrating to Mudlet]]
+[[Manual:Introduction|Introduction to Mudlet]] | [[Manual:Technical Manual|Technical Manual]] | [[Manual:Migrating|Migrating to Mudlet]]
 ; Enhancing your Mudlet experience.
-[[Manual:Scripting|Scripting]] | [[Manual:Lua Functions | Lua API and Reference]] | [[VyzorGuide|Vyzor Guide]]
+[[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" |
 ; Architecture
 : An overview of the key parts of Mudlet's source code.
-: [[Manual:Code|Code]] | [[Manual:Global object variables|Global object variables]] | [[Compiling Mudlet | Compiling Mudlet]]
+: [[Compiling Mudlet | Compiling Mudlet]] | [[Relevant_Developer_Tutorials|Relevant Developer Tutorials]] | [[Manual:Versioning|Versioning strategy]]
 |}
@@ Line 34: / Line 33: @@
 == Improving the manual ==
 * 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 [http://mudlet.org/forums The  Mudlet Forum] and ask your question there and someone will help you.
+* 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.
 * See also [[Project:Current issues]].