home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #27 / NN_1992_27.iso / spool / alt / galactic / 743 < prev    next >
Encoding:
Text File  |  1992-11-15  |  5.6 KB  |  128 lines
  1. Newsgroups: alt.galactic-guide
  2. Path: sparky!uunet!caen!zaphod.mps.ohio-state.edu!rpi!cleggp
  3. From: cleggp@aix.rpi.edu (Paul Jason Clegg)
  4. Subject: ADMIN:  Article Formatting Guide
  5. Message-ID: <rfv1sfj@rpi.edu>
  6. Nntp-Posting-Host: aix.rpi.edu
  7. Organization: Rensselaer Polytechnic Institute, Troy, NY
  8. Date: Mon, 16 Nov 1992 00:41:34 GMT
  9. Lines: 117
  10.  
  11.                     Writing Guide for Entries
  12.                        For Publication in
  13.            The HitchHiker's Guide to the Known Galaxy
  14.  
  15.     Entries in the HHGTTKG have a very specific format to allow for
  16. easy parsing by third-party readers.  Although we will accept entries that
  17. do not conform with the following standard (standard as of 3-19-92), we
  18. (the editors of the Guide) ask that potential field researchers and towel
  19. owners try to put their entries in as close to true form as possible, making
  20. it a lot easier on our editors.
  21.  
  22. Sample Format:
  23.  
  24. %t Title
  25. %n identification number
  26. %s summary
  27. %a author
  28. %d date (in yyyymmdd format)
  29. %x xrefs (unlimited number)
  30. %i index (unlimited number)
  31. %e Entry beginning
  32. This is a sample entry.
  33. %e Entry end.
  34.  
  35. %t Title:  Should not wrap around an 80-column screen, if possible.  This
  36.            is the subject title of the entry.  Names should be put in
  37.            last, first middle fashion.
  38.  
  39. %n ID Number:  This string is composed of three main parts: editor ID, reality
  40.            index, and message ID.  The editor ID is the number up until the
  41.            reality index, and the message ID is the number after that.  Every
  42.            editor will have a unique ID number.  The reality index is a single
  43.            character, either R (for Real articles) or U (for Unreal articles).
  44.            The message ID number is in hexidecimal, and may contain chars A-F.
  45.            For example, the 19th real article editor 4 makes will have the id
  46.            number of 4R13.
  47.  
  48. %s Summary:  Should not wrap around an 80-column screen, if possible.  This
  49.            is just a short one-liner about the entry, without going into
  50.            too much detail.
  51.  
  52. %a Author:  Your name, in straight first-middle-last fashion.  In parenthesis,
  53.            add your email address after your name, so that people can figure
  54.            out who to talk to if they have questions (more likely, it'll be
  55.            for the editors and such to get back to you).
  56.  
  57. %d Date:  The date you wrote the article.  The fashion is yyyymmdd, so
  58.            December 25, 1991 would be written 19911225.  Single-digit
  59.            numbers should be filled out with zeros.  July 4, 1991 would
  60.            be 19910704, NOT 199174!
  61.  
  62. %x XRefs:  Cross references.  Your entry can contain any number of logical
  63.            cross references.  Each should be on a separate line starting
  64.            with the %x marker.  These lines should contain the names of
  65.            ACTUAL ENTRY TITLES.
  66.  
  67. %i Indexes:  These are names by which the Title might also be known by.
  68.            Your entry may contain any number of these, so long as each is
  69.            on a separate line marked by the %i marker.  For entries on 
  70.            people, indexes that should definitely be included are their
  71.            full names in first-middle-last format, their first-last names,
  72.            their last-first names, and so on.  This also includes permutations
  73.            of the title, such as RPI, Rensselaer Polytechnic, and Rensselaer
  74.            Polytechnic Inst, would all be %i's for Rensselaer Polytechnic
  75.            Institute.  Don't be afraid to go a bit overboard, just so long as
  76.            every index used is obviously appropriate.
  77.  
  78. %e Entry Markers:  These indicate the beginning and ends of the entries.
  79.            These markers should occupy a single line by themselves.  Every-
  80.            thing after the first %e is the entry, and the entry is ended by
  81.            another %e on a separate line.
  82.  
  83. ENTRY FORMATTING:
  84.  
  85.     For readability, space considerations, and technical reasons, the
  86. editors of the Guide ask that your entries be written in a specific format.
  87.  
  88. Tabulation:  The beginning of every paragraph should NOT start with a tab.
  89.  
  90. Paragraph spacing:  There should be an extra blank line between paragraphs,
  91.         but NOT after the final paragraph, which should be followed by the %e.
  92.  
  93. Lists:  If, for some reason, you find a list necessary for your entry, it
  94.         should be spaced in from the left 10 characters, and begin with a
  95.         number, followed by a ) .  Thus, the 3rd entry in a list would begin:
  96.  
  97.           3) This is the third part of a list.
  98.  
  99.         If, for some reason, your list goes to 1000, do NOT add commas in the
  100.         number.  Also, there should be a blank line just before the first
  101.         list entry, and just after the last entry, as seen in the example
  102.         above.
  103.  
  104. Underlining:  Things that should be underlined (like book names) should be
  105.         preceded by an underscore "_" and then ended with an underscore "_",
  106.         but there should NOT be underscores between words.  Thus, the name
  107.         of The HitchHiker's Guide to the Galaxy would be written as _The
  108.         HitchHiker's Guide to the Galaxy_, and NOT _The_Hitch.. etc...
  109.  
  110. Hyphenation:  Words should NOT be hyphenated at the end of a line.  If it
  111.         doesn't fit, just move the whole thing to the next line.
  112.  
  113. Final Notes:
  114.      This is version 0.10 Beta of the format.  There may still be a few things
  115. to be altered in the near future, but the items mentioned here are pretty
  116. definite.
  117.  
  118. ...Paul
  119.  
  120.  
  121.  
  122.  
  123. -- 
  124. +                +        +    +  + + +  +    +        +                +
  125.   Paul Clegg, cleggp@aix.rpi.edu.   Project Galactic Guide Coordinator.
  126.             System One RPG designer.   But generally unknown.
  127. +                +        +    +  + + +  +    +        +                +
  128.