Difference between revisions of "Manual:Contents"

From Mudlet
Jump to navigation Jump to search
m (Changed "to do" link to remove unnecessary slashes and include in the Manual namespace)
Line 33: Line 33:
  
 
== Improving the manual ==
 
== Improving the manual ==
* There are still a lot of holes in this manual!  See the [[/To do/|'to do' page]] for details.
+
* 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 [http://mudlet.org/forums 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.

Revision as of 09:08, 11 March 2012

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.


Main sections

For End Users

For Developers

Guide to using Mudlet client.

Introduction to Modern MUD Clients | Technical Manual | Migrating to Mudlet

Enhancing your Mudlet experience.

Scripting | Lua API and Reference

Architecture
An overview of the key parts of Mudlet's source code.
Code | Global object variables | Compiling Mudlet

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.

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.