Mercurial > hg > batmud > ggrtf
changeset 1230:8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Fri, 04 Jun 2010 11:00:48 +0000 |
parents | 2871db57f976 |
children | 4c6e13bc9d11 |
files | docs/manual.sgml |
diffstat | 1 files changed, 98 insertions(+), 28 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Sat May 29 06:52:07 2010 +0000 +++ b/docs/manual.sgml Fri Jun 04 11:00:48 2010 +0000 @@ -9,7 +9,7 @@ <!ENTITY svnrepo "<ulink url='http://dev.pupunen.net/public/ggrtf/trunk/'>Subversion-repository</ulink>"> <!ENTITY svnurl "<ulink url='http://subversion.tigris.org/'>Subversion</ulink>"> <!ENTITY batmudurl "<ulink url='http://www.bat.org/'>BatMUD</ulink>"> -<!ENTITY pupuneturl "<ulink url='http://www.pupunen.net/'>Pupunen.net</ulink>"> +<!ENTITY pupuneturl "<ulink url='http://dev.pupunen.net/'>dev.pupunen.net</ulink>"> <!ENTITY gnupgurl "<ulink url='http://www.gnupg.org/'>GnuPG</ulink>"> <!ENTITY trackerurl "<ulink url='http://dev.pupunen.net/mantis/'>bugtracker</ulink>"> @@ -19,7 +19,7 @@ <!ENTITY colourexplanation " Colours described here may deviate from what you actually -see due to differences in terminal emulation programs. +see due to differences in terminal emulation programs and settings. "> <!ENTITY sectmacros_1 "<title>Macro commands</title> @@ -498,45 +498,115 @@ <chapter id="inst-config"><title>Configuration</title> <para> -After getting GgrTF and unpacking the files to appropriate -directory folder, you need to setup your configuration for &tfurl; -and possibly change some of your settings in &batmudurl;. +After extracting GgrTF files into the appropriate directory folder, +you will need to create (or change) configuration for &tfurl; to load GgrTF +modules and possibly change some of your settings in &batmudurl;. </para> <para> -If you are upgrading GgrTF from a previous version, it is probable -that you do not have to change your configuration. But in case of -odd problems you may wish to skim through this section, -the ChangeLog and module-specific sections of this manual in -case of any significant, backwards incompatible changes. +If you are upgrading GgrTF from a previous version, it is possible +that you do not have to change your configuration. But it is neverthless +recommended that you skim through this section, the ChangeLog and +module-specific sections of this manual in case of any significant, +backwards incompatible changes. </para> -<section id="inst-config-tf"><title>TF configuration</title> +<section id="inst-config-tf"><title>TF configuration file</title> <para> -First, we have to set up TF's configuration. Location of the file -containing the startup script for TF depends on your operating -system environment. +Typical way to use GgrTF is to load the script modules at startup. +This is accomplished via TinyFugue's configuration file, commonly +referred as "tfrc", location of which depends on your operating +system and environment. </para> <itemizedlist> <listitem><para> - UNIX- and compatibles and CygWin-based Win32 ports: - <emphasis>~/.tfrc</emphasis> - (File named ".tfrc" in your user's home directory) + UNIX- and compatibles, like Linux: + <emphasis>~/.tfrc</emphasis> or <emphasis>$HOME/.tfrc</emphasis> + (aka a file named ".tfrc" in your user home directory.) </para></listitem> -<!-- - <listitem><para>DruWare Win32 port of TF: -<emphasis></emphasis> -</para></listitem> ---> + <listitem><para> + DruWare Win32 port of TF: + <emphasis></emphasis> + </para></listitem> </itemizedlist> <para> - +As a basis for your TF configuration, you can use the example-tfrc.txt +provided with GgrTF. You will need to edit it to suit your guilds and +certain settings. However, the example-tfrc is only a suggested layout +of configuration, mostly to show the order GgrTF requires modules +and settings to be loaded. It does not contain everything you can possibly +do with TF. +</para> + +<para> +Take note of the order of how different parts of GgrTF are loaded and where +certain variables are set. Important thing is to have the order right, certain +modules depend on other modules, and while GgrTF will usually print warning message(s) +if the depencies are not met, sometimes this is not possible and erratic behaviour +will occur. +</para> + +<screen>&exampletfrc;</screen> + + +<section id="inst-config-tf-locale"><title>Character set encoding and locales</title> +<para> +One thing that is out of scope of GgrTF itself, is the issue of character set +translation and locales. This basically means the way different characters +are encoded and interpreted, how different values map to characters and vice versa, +for example a simple encoding might be A=1, B=2, C=3, etc. </para> +<para> +One of the first and most widely used character encodings on computer systems +is known as <ulink url="http://en.wikipedia.org/wiki/ASCII">7-bit ASCII</ulink>. +This encoding allows 128 symbols or characters, and was commonly used for decades. +Unfortunately, 128 symbols is nearly not sufficient enough to represent all the +different alphabets or symbols used around the world (scandinavian characters, +cyrillic alphabet, etc.) Thus other encodings were invented, most of them +incompatible with each other, until introduction of Unicode standard and especially +<ulink url="http://en.wikipedia.org/wiki/UTF-8">Unicode UTF-8</ulink>. +</para> + +<para> +The de-facto character set used in BatMUD is called "ISO-8859-1" which is +a 8-bit encoding that allows 7-bit ASCII characters and 8-bit encoding of +scandinavian characters (A and O with dots, etc). This is mostly due to +BatMUD's origin in Finland, where ISO-8859-1 has been most deployed. +</para> + +<para> +However, increasing number of systems are starting to use Unicode "UTF-8" +encoding, and other encodings are also still used. Unicode is a good thing +in itself, and UTF-8 allows compatible 7-bit ASCII characters, but 8-bit +and over are not compatible with ISO-8859-1. This is why if your system +uses UTF-8, other people in BatMUD may see your non-ASCII characters +incorrectly. +</para> + +<para> +Now that we know the issue, what can we do? Sometimes the solution may +be very simple, but in many cases rather complex and very dependant +on your setup - e.g. where you run TF, is it a shell or running locally, etc. +Below is a list of tips and pointers, which may be of some help. <emphasis>However, +this is all the assistance we can provide, please do not ask us about these +issues.</emphasis> +</para> + +<itemizedlist> + <listitem><para> + </para></listitem> + + <listitem><para> + </para></listitem> +</itemizedlist> + +</section> + <!-- - intro - layout of recommended configuration @@ -597,9 +667,9 @@ <para> In case you do NOT want to change your settings to the way GgrTF needs -them to be, your only option is to change the regular expression patterns -in GgrTF's code to match your preferences (and possibly redo the changes -when/if you upgrade GgrTF.) +them to be, your only option is to change the regex patterns in GgrTF's +code to match your preferences (and redo the changes each time you +upgrade GgrTF.) </para> </section> @@ -1169,7 +1239,7 @@ <section id="usage-general-saves-special"><title>Special, non-saved variables</title> <para> There are currently three special GgrTF variables, which you have to -set yourself in your TF's startup configuration (".tfrc"-file). +set yourself in your TF's startup configuration (.tfrc). These variables <emphasis>MUST</emphasis> be set before loading of ANY GgrTF modules, otherwise things start breaking and the state-saving system does not work correctly. @@ -1642,7 +1712,7 @@ By defining "opt_bindings" before loading GgrTF modules, user can choose to enable or disable the default bindings, even "per-module" by changing the value of opt_bindings before each module loading in -tfrc. +.tfrc. </para> <para> It should be noted, that "opt_bindings" is a saveable setting, that gets