Cleaning up existing files

This article provides information about the necessary clean up for the files that were on the M4 Documentation Wiki and have been transformed into xHTML. This is a living site with additions being added as we find them in the files, so check the listing often.

Go ahead and clean up these items

The following clean up is currently necessary:

• Replace occurrences, in each file, of "Zero" or "Project Zero" as follows:
  • First occurrence, within each file:

    IBM® WebSphere® sMash
    

    If this occurs in the title (h1 tag) of the article, do not use the reg symbols but put them on the first occurrence in the text.
  • Each occurrence, in each file, thereafter:

    WebSphere sMash
    

• Replace any occurrences, in each file, of "RTE" or "reliable transport extension" a follows:
  • First occurrence, within each file:

    IBM® Reliable Transport Extension for WebSphere® sMash
    

    If this occurs in the title (h1 tag) of the article, do not use the reg symbols but put them on the first occurrence in the text.
  • Each occurrence, in each file, thereafter:

    IBM Reliable Transport Extension
    

• Change the coding in your files to use the classes and special coding described in the Article development: using the template article.


• Remove any twiki specific links, such as class="twikiLink" or class="twikiCurrentWebHomeLink twikiLink". Use one of the following (as described in the Article development: using the template) instead:

  • <a href="http://www.w3.org" class="externalURL">World Wide Web Consortium</a>

  • <a href="nameoffile.htm" class="fileReference">Name of File</a>

• Remove cross module links and replace with searchable text, as discussed in the Cross module linking section of the HTML coding and best practices article.
• Remove anchor names (sometimes they even appear twice from the transform process) in headings and place the ID on the h1 tag, as shown in the following example:
  Before:

  <h1><a name="Events"><a name="Events"></a>  Firing events </h1>
  

  After:

  <h1 id="Events">Firing events</h1>
  

• Make sure all files have an h1 tag with the name of the article:

  <h1 id="title">Title</h1>

• Replace any links to the documentation page with:

  <a href="http://www.projectzero.org/documentation">Documentation</a>

• Replace the paragraph tag as shown in the following example:
  • Before:

    <p />Text text text

  • After:

    <p>Text text text</p>

• Remove empty anchor tags. This causes browsers to display content incorrectly and provides no added value. In most cases, the anchor tag can be replaced with an ID on the appropriate tag.
• Trademark Attribution:
  1. Search for products and manufacturers in trademark list (found on the Trademark information page.)
  2. Mark the first occurrence, in each individual article, with the appropriate trademark symbol (to add the tm or ® marks) as:

     • ™

       which yeilds: Name™, for example Java™

     • ®

       which yeilds: Name ®, for example DB2®
  3. Maintain a list of the terms you and your team mark in your module. This will be used to create the attributions page later. (For more information on the attributions page, see the IBM internal Trademark information page.)


• If your files do not already have one, add a short description in each file, as shown in the following example:

  <div class="shortdesc">
  <p>Insert a short, 1 or 2 sentence summary of what this 
  article is about so that users can decide, at a glance, 
  if this is the information they're seeking.
  </p>
  </div>