Difference between revisions of "HOWTO: Add an errata entry"

From FBSwiki
Jump to: navigation, search
 
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
This HOWTO describes how to create a new errata entry.  Each erratum is on a single page, with information about the location, corrected text and contributor.  You must be a registered user on the wiki in order to create an errata entry.
 +
 +
=== Creating a new errata entry page ===
 
To add a new erratum, you need to perform the following steps:
 
To add a new erratum, you need to perform the following steps:
 
<ol>
 
<ol>
<li> Type the name of the erratum page into the search box.  The erratum title should be of the form
+
<li><p> Type the name of the erratum page into the search box.  The erratum title should be of the form
<blockquote>Erratum: description of erratum in page independent manner</blockquote></li>
+
<blockquote>Errata: Description of erratum in page independent manner</blockquote>
<li> Click on the 'create this page' link in the search results.  This will create a new page and put you into the editor. </li>
+
The text should identify where the error occurs, but not refer to any specific page (since these change between editions).  See the [[errata page]] for examples of how to do this.</p></li>
<li> Enter the erratum information using the {{:erratum template}} by entering the following text into the new page:
+
<li><p> Click on the 'create this page' link in the search results.  This will create a new page and put you into the editor. </p></li>
 +
<li><p> Enter the erratum information using the [[:Template:Errata template|errata template]] by entering the following text into the new page:
 
<pre>
 
<pre>
  <nowiki>{{subst:erratum template}}</nowiki>
+
  <nowiki>{{subst:errata template}}</nowiki>
</pre></li>
+
</pre></p></li>
<li>Save the page and then re-edit it.  At this point you can fill in the required information using the documentation provided in the template.</li>
+
<li><p>Save the page and then re-edit it.  At this point you can fill in the required information using the documentation provided in the template.</p></li>
 +
<li><p> Enter the erratum into the master [[errata page]]. </p></li>
 
</ol>
 
</ol>
  
Contents of the {{:erratum template}}:
+
=== How to fill in the template ===
  {{erratum template}}
+
The template contains a single template with entries for the following information:
 +
* chapter - Replace with the (capitalized) chapter name where the error occurs
 +
* page - Page number of the erratum
 +
* line - Line number of the erratum
 +
* contributor - Name of the contributor. Uses initials + last name (R. M. Murray)
 +
* date - Date on which the erratum was reported.  Use the form 'DD Mon YY' (5 Apr 08)
 +
* version - Version in which the erratum occurred (usually 'First printing')
 +
* text - Text for the description of the error and the fix.  This can be multiple lines, but can't include templates

Latest revision as of 20:30, 5 April 2008

This HOWTO describes how to create a new errata entry. Each erratum is on a single page, with information about the location, corrected text and contributor. You must be a registered user on the wiki in order to create an errata entry.

Creating a new errata entry page

To add a new erratum, you need to perform the following steps:

  1. Type the name of the erratum page into the search box. The erratum title should be of the form

    Errata: Description of erratum in page independent manner
    The text should identify where the error occurs, but not refer to any specific page (since these change between editions). See the errata page for examples of how to do this.

  2. Click on the 'create this page' link in the search results. This will create a new page and put you into the editor.

  3. Enter the erratum information using the errata template by entering the following text into the new page:

     {{subst:errata template}}
    

  4. Save the page and then re-edit it. At this point you can fill in the required information using the documentation provided in the template.

  5. Enter the erratum into the master errata page.

How to fill in the template

The template contains a single template with entries for the following information:

  • chapter - Replace with the (capitalized) chapter name where the error occurs
  • page - Page number of the erratum
  • line - Line number of the erratum
  • contributor - Name of the contributor. Uses initials + last name (R. M. Murray)
  • date - Date on which the erratum was reported. Use the form 'DD Mon YY' (5 Apr 08)
  • version - Version in which the erratum occurred (usually 'First printing')
  • text - Text for the description of the error and the fix. This can be multiple lines, but can't include templates