home *** CD-ROM | disk | FTP | other *** search
/ linuxmafia.com 2016 / linuxmafia.com.tar / linuxmafia.com / waygate / NEW / Guidelines next >
Text File  |  1997-10-03  |  8KB  |  210 lines
  1.                Guidelines for web pages in the Waygate
  2.                =======================================
  3.  
  4. All new pages are to be written according to the HTML 4.0
  5. transitional specification, and should validate using its DTD.
  6.  
  7. This is indicated by the doctype declaration first in the HTML
  8. document:
  9.  
  10. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  11.  
  12. Earlier pages should be made to conform to either the HTML 4.0, HTML
  13. 3.2 or HTML 2.0 specification, as is appropriate for the page. This is
  14. indicated by the following doctypes for HTML 3.2 and HTML 2.0.
  15.  
  16. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
  17. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  18.  
  19. New pages are to be written in normalised form, ie all start- and
  20. end-tags in container elements should be present. Ie: <P>...</P> and
  21. <LI>...</LI> instead of just <P> or <LI>. This to faciliate style
  22. sheet support and automatic processing.
  23.  
  24. The pages are most easily validated with the html-check command, which
  25. invokes the nsgmls SGML parser. Errors are listed with file, line
  26. number, column and cause of error.
  27.  
  28. There is a standardised template for the pages available in the file
  29. "Template.html".
  30.  
  31. MANDATORY LINKS
  32. +++++++++++++++
  33.  
  34. All pages should have a LINK element in the HEAD section with the
  35. following:
  36.  
  37. <LINK REV="Made" HREF="mailto:wot@hugin.imat.com">
  38.  
  39. All pages should also have a LINK element in the HEAD section
  40. pointing to the main page for the Waygate:
  41.  
  42. <LINK REL="Top" HREF="url-to-the-waygate" TITLE="The Waygate">
  43.  
  44. If appropriate, they should also have similar LINK elements
  45. pointing to surrounding pages.
  46.  
  47. The following REL values may be used:
  48.  
  49. Top - always points to the main Waygate page
  50. Parent - the page directly above the page, if this is not the
  51.   main Waygate page. TITLE should be set to "Up".
  52. Begin - The first or "main" page in a sequence of pages
  53. Next - the next page in a sequence
  54. Previous - the previous page in a sequence
  55.  
  56. New values may be added as the need arises. In particular, once one or
  57. a few site-wide stylesheets have been written the pages should have a
  58. Stylesheet link element.
  59.  
  60. The values shall be written with lowercase characters, except for the
  61. first uppercase character.
  62.  
  63. All pages should have a mailto- or form-link for sending e-mail to
  64. <wot@hugin.imat.com> in the body. "<wot@hugin.imat.com>" or simply
  65. "wot@hugin.imat.com" should be used as the link text. Similarly, all
  66. pages should have a link in the body pointing to the main Waygate
  67. page, using "The Waygate" as the link text. Additional links to
  68. surrounding pages are to be used if appropriate.
  69.  
  70. CODING TECHNIQUES
  71. +++++++++++++++++
  72.  
  73. Tables should be avoided for layout purposes. If they are used for
  74. layout, the table should be made as small as possible due to the
  75. rendering drawbacks. Any width listed must be in percentage form.
  76.  
  77. Frames must not to be used.
  78.  
  79. The elements B, I, TT, U, S and STRIKE must not to be used.
  80.  
  81. BLOCKQUOTE must not be used for indenting purposes, but only to mark a
  82. longer quotation (one spanning one or more paragraphs). Likewise must
  83. not the list elements (OL, UL and DL) be used for indenting.
  84.  
  85. NAVIGATION IN PAGE
  86. ++++++++++++++++++
  87.  
  88. Different parts of the page are to be accessible through the <A
  89. NAME="foo">...</a> construct, if appropriate. The A element must be
  90. given a non-empty content, preferably the text of the heading of the
  91. section or similar.
  92.  
  93. Do not use this construct for providing a link to the top of the page.
  94. The back button and scroll bar are sufficient for that.
  95.  
  96. LINKS
  97. +++++
  98.  
  99. Links to pages with more than 40k of text should be marked as such, in
  100. the form <A ...>link text</A> [XYKb].
  101.  
  102. Link texts are to be short and descriptive, three or four words at the
  103. most. "Click here" or any similar statement must not to be used as the
  104. link text.
  105.  
  106. All pages within the Waygate are to be referred with relative
  107. links. All links to the directory root pages should be given as "./"
  108. and not "index.html". Links to the WOTFAQ section are to be given as a
  109. relative absolute link (ie it begins with a "/").
  110.  
  111. All other links should be given in their complete form, including
  112. scheme and host, even if the page is stored on hugin.
  113.  
  114. IMAGES
  115. ++++++
  116.  
  117. A page is to be limited to a maximum of 15Kb of images, unless it is a
  118. dedicated image page. A dedicated image page should be noted as such
  119. in the link text. An image page should preferably be limited to at
  120. most 100Kb total (ie inclusive images).
  121.  
  122. All and any image is to be given an ALT text, replacing the image's
  123. functionality. For decorative images, ALT="" or ALT="*" is
  124. appropriate.
  125.  
  126. Every image that fulfills a role in and of itself should be a link to
  127. itself. For large such images (>15Kb) thumbnails are to be used.
  128.  
  129. Correct height and width values are to be supplied with every image.
  130. They are not to be used for scaling the image or creating thumbnails.
  131.  
  132. A shared image and icon library is in waygate/Pics, and the images
  133. there should be used whenever appropriate. The hugin-wide /icons/ image
  134. library may also be used.
  135.  
  136. HTML CODING DETAILS
  137. +++++++++++++++++++
  138.  
  139. Any editor may be used, as long as it produces valid HTML as
  140. defined above.
  141.  
  142. Case in the HTML tags does not matter, but lowercase is preferred.
  143.  
  144. Colour values or background images for the page may not be set in the
  145. BODY element. (Or use a fixed set?)
  146.  
  147. The character set of the pages is ISO-Latin-1 (ISO-8859-1). All
  148. characters in this set with values over 127 (decimal) are to be
  149. written as character entities. Diacractical characters (eg acute e,
  150. umlaut o or o-cedilla) should use the &mnemonic; code, other
  151. characters the &#numeric; code. A full list of of the character
  152. entities HTML uses for ISO-Latin-1 characters can be found at
  153. <http://www.htmlhelp.com/reference/charset/> <-- check!
  154.  
  155. FILE NAMES
  156. ++++++++++
  157.  
  158. HTML and other files shall have names in lowercase only. Directories
  159. and meta-files (like Todo files or this guideline) shall begin with an
  160. uppercase character, but be written in lowercase onwards. If several
  161. files belong together they should use a uniform naming scheme.
  162.  
  163. Every directory shall be given a file "index.html" that acts as the
  164. root page for the directory. It also prevents snooping on
  165. half-finished pages.
  166.  
  167. META INFORMATION
  168. ++++++++++++++++
  169.  
  170. If appropriate, the name of the author and/or editor of the document
  171. should be given. The META element may be used for this and other
  172. metainformation. The following META name values may be used if
  173. appropriate:
  174.  
  175. Author - author of the text
  176. Editor - if the text has been heavily edited
  177. Description - short description of the page
  178. Keywords - keywords for the text
  179.  
  180. Note that some search engines nowadays seems to discriminate against
  181. the use of the Keywords name value.
  182.  
  183. The META refresh construction may not be used, nor should META be used
  184. for specifying content-type or charset.
  185.  
  186. THE DIRECTORIES
  187. +++++++++++++++
  188.  
  189. The following directories exist in the Waygate:
  190.  
  191. Acos-pc - _A Crown of Swords_ plot contest
  192. Bela-pc - The Bela in LoC plot contest
  193. Bookart - Art from the books, ie covers and chapter icons. The
  194.   chapter icons are stored for maximal quality for later
  195.   processing and should not be used on the pages.
  196. Fiction - Fiction regarding either the books or the newsgroup
  197. Filk - Filk songs and lyrics
  198. Jordanites - Information about individual net.jordanites, with
  199.   pictures and home page links
  200. Loc-pc - _Lord of Chaos_ plot contest
  201. Loony - Loony theories
  202. Pics - Shared picture and icon archive for the pages
  203. Survey3 - The third Novak-Ghirardelli survey
  204. Tfoh-pc - _The Fires of Heaven_ plot contest
  205. Tr-pc - The Two Rivers in TFoH plot contest
  206.  
  207. Pages should normally not be placed directly in the Waygate/
  208. directory. New directories may be added as the need arises, but should
  209. preferably made general enough so that new files can be added later.
  210.