Difference between revisions of "Manual:Contents"

From Mudlet
Jump to navigation Jump to search
(Prepared the page for translation)
m (Reverted edits by TheFae (talk) to last revision by Kebap)
Tag: Rollback
Line 1: Line 1:
<languages/>
 
<translate>
 
 
<!--{{Hubs|banner|dev=y|admin=y}}-->
 
<!--{{Hubs|banner|dev=y|admin=y}}-->
 
[[File:{{#setmainimage:Mudlet-Manual.png}}|right|175px|Mudlet documentation]]
 
[[File:{{#setmainimage:Mudlet-Manual.png}}|right|175px|Mudlet documentation]]
 
This is a manual for both Mudlet users and developers on using, or developing, Mudlet.
 
This is a manual for both Mudlet users and developers on using, or developing, Mudlet.
 
  
 
==Main sections==
 
==Main sections==
 
 
{| class="MainPageBG" style="width:100%; border:1px solid #c9c07f; background:#fdf7bb; vertical-align:top; color:#000;" |
 
{| 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" |
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 
 
==For MUD Players==
 
==For MUD Players==
 
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 
  
 
==For Developers==
 
==For Developers==
 
 
|-
 
|-
 
| style="width:50%; vertical-align:top; border:none" |
 
| style="width:50%; vertical-align:top; border:none" |
 
; Guide to using Mudlet client.
 
; Guide to using Mudlet client.
[[Special:MyLanguage/Manual:Introduction|Introduction to Mudlet]] | [[Special:MyLanguage/Manual:Technical Manual|Technical Manual]] | [[Special:MyLanguage/Manual:Migrating|Migrating to Mudlet]]
+
[[Manual:Introduction|Introduction to Mudlet]] | [[Manual:Technical Manual|Technical Manual]] | [[Manual:Migrating|Migrating to Mudlet]]
 
; Enhancing your Mudlet experience.
 
; Enhancing your Mudlet experience.
[[Special:MyLanguage/Manual:Scripting|Scripting]] | [[Special:MyLanguage/Manual:Lua Functions | Lua API and Reference]] | [http://oneymus.github.io/Vyzor/ Vyzor Guide] | [[Special:MyLanguage/Manual:Geyser| Geyser 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" |
 
| style="width:50%; vertical-align:top; border:none" |
 
; Architecture
 
; Architecture
 
: An overview of the key parts of Mudlet's source code.
 
: An overview of the key parts of Mudlet's source code.
: [[Special:MyLanguage/Compiling Mudlet | Compiling Mudlet]] | [[Special:MyLanguage/Relevant_Developer_Tutorials|Relevant Developer Tutorials]] | [[Special:MyLanguage/Manual:Versioning|Versioning strategy]]  
+
: [[Compiling Mudlet | Compiling Mudlet]] | [[Relevant_Developer_Tutorials|Relevant Developer Tutorials]] | [[Manual:Versioning|Versioning strategy]]  
 
|}
 
|}
 
  
 
=== Others ===
 
=== Others ===
 
+
; [[FAQ|Mudlet FAQ]]
; [[Special:MyLanguage/FAQ|Mudlet FAQ]]
 
 
: Frequently asked questions about Mudlet.
 
: Frequently asked questions about Mudlet.
 
  
 
== Browsing the manual ==
 
== 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 [[#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 [[Special:MyLanguage/#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:|Special:Allpages/Manual:]] - An automatically generated list of all pages in the Manual: namespace.
+
* [[:Category:Mudlet Manual]] - the top-level Manual category
* [[:Category:Mudlet Manual|: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 [[Manual:To do|'to do' page]] for details.
* There are still a lot of holes in this manual!  See the [[Special:MyLanguage/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 [https://forums.mudlet.org/ 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|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|Project:Current issues]].
+
* See also [[Project:Current issues]].
 
<!--
 
<!--
 +
{{Languages}}
  
 
</translate>
 
 
{{Categories}}
 
{{Categories}}
<translate>
 
  
</translate>
 
 
{{Mudlet Manual list}}
 
{{Mudlet Manual list}}
<translate>
 
 
-->
 
-->
 
[[Category: Mudlet Manual]]
 
[[Category: Mudlet Manual]]
</translate>
 

Revision as of 07:57, 3 September 2019

Mudlet documentation

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.

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.