home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Games / Zangband / help / readme.txt < prev    next >
Text File  |  2000-08-26  |  5KB  |  113 lines
  1. === Notes on Zangband Documentation ===
  2.  
  3. This file sets out basic information regarding the official Zangband
  4. documentation package produced by the Zangband DevTeam. 
  5.  
  6.  
  7. --- Documentation Packages ---
  8.  
  9. There are currently two documentation packages planned. The basic
  10. package will include non-spoiler information necessary for a new player
  11. to learn all he needs to know about playing Zangband and will be
  12. included in all official Zangband source and binary releases. The
  13. extended package will included additional spoiler files and will be
  14. available for download separately. Care will be taken to ensure that
  15. the two packages merge together properly.
  16.  
  17.  
  18. --- Available Formats ---
  19.  
  20. The Zangband documentation packages will be made available in three
  21. formats for download, plain text, html and .chm (for windows users).
  22. The plain text version will run from the in-game '?' command. The html
  23. version will be placed on the web and will be made available for
  24. download to allow local browsing. The *.chm file is a windows specific
  25. format which allows adaption of html documentation packages to be used
  26. in windows helpfiles. It introduces full text searching and many other
  27. nice features.
  28.  
  29.  
  30. --- Reporting Errors / Suggestions for Improvement ---
  31.  
  32. While every effort will be taken to ensure that the documentation
  33. packages are accurate and up to date, it is inevitable that some
  34. errors will be made. If you find an error or have a suggestion to
  35. improve documentation, please post your report or idea to the Zangband
  36. Development list by mailing to zangband@onelist.com. Alternatively, you
  37. may post your report or idea to rec.games.roguelike.angband.
  38.  
  39.  
  40. --- Rules for Creating Documents ---
  41.  
  42. Certain general rules have been applied in creating the official
  43. documentation for Zangband. The DevTeam welcomes contributions by
  44. players and if you wish to contribute a spoiler or other helpfile we
  45. would appreciate your adherence to the following guidelines. We reserve
  46. the right to modify your file but you will retain credit as the
  47. original author.
  48.  
  49. 1.  All documents should be named using the standard 8.3 format since
  50.     Zangband is played on systems which do not support long filenames.
  51. 2.  Menu files should be named *.hlp, non-spoiler help files *.txt and
  52.     spoiler helpfiles *.spo.
  53. 3.  All documents should be in a fixed font, plain text format.
  54. 4.  Line length should be between 70 and 75 characters.
  55. 5.  Please use US spelling unless it directly conflicts with the game
  56.     (for example the 'Spectre' race).
  57. 6.  No indenting of the first line of paragraphs.
  58. 7.  Left justification.
  59. 8.  Document titles are denoted by '=== Document Title ==='.
  60. 9.  Section headings are denoted by '=== Section Heading ==='.
  61. 10. Sub-section headings are denoted by '--- Sub-section Heading ---'.
  62. 11. Information on document authors and editors and revisions should
  63.     be included at the end of each document.
  64. 12. Indenting increments by 4 or 5 spaces each time.
  65.  
  66.  
  67. === Hyperlinks ===
  68.  
  69. Zangband supports links between help files as follows. At the point in
  70. the text where you wish to insert a link, place the text '[#]' where '#'
  71. is any letter or digit ('a' and 'A' are distinct for this purpose).
  72. This is to tell the reader which key to press to activate the link.
  73. Then, at the end of the file, place the following text (including the
  74. asterisks) where 'target_filename' is the name of the file you wish to
  75. link to:
  76.  
  77.      ***** [#] target_filename
  78.  
  79. Now, when the user presses '#', the helpfile system will open up the
  80. target file. Opening the new file will flush the previous links so
  81. '#' may be reused.
  82.  
  83. Note: because various operating systems use different conventions to
  84. denote directory structures, Zangband does not support target file
  85. names like './spoiler/races/races.spo'. This means that all help files
  86. should be kept in the lib/help or lib/info directory.
  87.  
  88. We are currently testing methods of linking to a particular section
  89. in a document and may also implement histories to allow 'back' and
  90. 'forward' actions similar to web browsers.
  91.  
  92. --- Tags ---
  93.  
  94. A "tag" is something like a bookmark, it marks a line for reference by
  95. a hyperlink.  A tag is specified with:
  96.  
  97.     ***** <tag_name>
  98.  
  99. (the name of the tag can not be longer than 15 characters).
  100.  
  101. You can then jump to the line marked with the tag with:
  102.  
  103.     ***** [1] target_filename#tag_name
  104.  
  105. This command jumps to the line with the tag "tag_name" in the file
  106. target_file.  You can jump inside the current file too (just use the
  107. filename of the current file in the link).
  108.  
  109. -- 
  110. Original    : Zangband DevTeam
  111. Last update : January 13, 2000
  112.  
  113.