changeset 1377:91d712edde9f

Added section for Identify module.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 29 Mar 2011 15:21:29 +0300
parents 3d73752368ae
children fbf2af8e3128
files docs/manual.sgml
diffstat 1 files changed, 41 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Tue Mar 29 14:42:33 2011 +0300
+++ b/docs/manual.sgml	Tue Mar 29 15:21:29 2011 +0300
@@ -2827,6 +2827,47 @@
 
 <!-- ================================================ -->
 
+<section id="usage-identify"><title>Identify output beautifier (gm-identify.tf)</title>
+<para>
+Provides a simpler and more readable view of 'identify' spell's output.
+Not all information can be caught gracefully, however, and thus you should
+refer to the raw output for details such as "tales" and other special information.
+</para>
+
+<para>
+Example of output:
+</para>
+<screen>
++-| General |----------------------------------------------------------------+
+| Item....: a pair of stylish blue breeches                                  |
+| Name....: blue breeches                                                    |
+| Handles.: 'breeches', 'stylish blue breeches', 'silk breeches' and         |
+|           'pants'                                                          |
+| Names...: Molotov, Belse and Ekkivekki                                     |
+| Slots...: leg and leg                                                      |
+| Material: silk                                                             |
++----------------------------------------------------------------------------+
+| In game.: 2y, 104d, 16h, 13min and 58s   | Condition: great                |
+| Size....: somewhat small                 | Maxcond..: AWESOME              |
+| Worth...: 8851                           | Quality..: superb               |
+| Weight..: almost weightless              | Weight/kg: 0.050                |
++-| Stats |------------------------------------------------------------------+
+| insignificantly improve your wis                                           |
++-| Misc |-------------------------------------------------------------------+
+| Worn....: Ekkivekki for 48d, 17h, 13min and 9s, Prince charming for 2h,    |
+|           5min and 44s and Slobber for 157d, 14h, 48min and 52s            |
+| Wielded.:                                                                  |
++----------------------------------------------------------------------------+
+</screen>
+
+<!-- @commands -->
+<!-- @binds -->
+<!-- @keybinds -->
+
+</section>
+
+<!-- ================================================ -->
+
 <section id="usage-rpouch"><title>Reagent Pouch handler (gm-rpouch.tf)</title>
 <para>
 This module provides utilities for reagent pouch handling, especially useful