Updating Part 2

The HTML Documents

I. HTML Primer

1. The Comment Tag

Important terms are in white with dotted underline: Important!

  1. Purpose:

    • The Comment Tag is used to add, as you might expect, various types of comments to HTML documents. These comments are ignored by browsers and only visible when viewing the document's source code. In our example, we will primarily use Comment Tags to identify a closing tag as belonging with it's opening tag.

  2. Format:

    • Basic format of the Comment Tag:

      <!-- comment text -->

    • An in context example of the format would be:

      <div id="example">
      ...several lines of code...
      </div><!-- End: "example" -->

  3. Illustrations:

      Figure: 1.1: Example of using the Comment Tag in HTML Kit.

  4. Summary:

    • While it's unlikely you will need to add Comment Tags to HTML documents, knowing how they work can help in navigating through long documents using the FIND button. This will be covered more in-depth in the following sections.

2. Indentation Rules.

  1. Purpose:

    • The purpose of indentation is a fairly simple concept: To provide visual clues to where an HTML tag opens: <tag> and where it closes: </tag> Especially in cases where multiple lines of code lie between the opening tag and the closing tag.

    • HTML tags are divided into two main categories that help define when to use line breaks and indents and when not to. So lets look at each and see some examples.

    • Inline Elements:

      Inline elements are defined as any HTML tags that do not interrupt he normal flow of the page structure, but simply flow along naturally with the text or whatever else is being presented. For example:

      I am giving an <span class="em">example</span> of an inline element called a SPAN tag.

      Normally, inline tags do not need line breaks or indents applied to them. There are a handful of these, but most are used only in very special circumstances; for example, citations, or for acronyms.

      The only two we really need to know are:

      The SPAN tag: <span></span>

      And the BREAK tag: <br />
      The BREAK tag is rather special in a couple ways, first it's opening and closing are contained within the same tag: Open <br and Close: /> Second, it's an inline tag, but it's purpose is to insert a hard line break... so it kind of does interrupt page flow. I sometimes use line breaks and indents on this tag, if it's seems logical to me.

    • Block Elements:

      Block elements are elements that form a section or "block" of a page, and can span multiple lines of code, and quite frequently several more Block elements. Without indentation and Comment tags, keeping track of the tag pairs can be a nightmare. Here's a list of the Block Elements we're likely to encounter:

      The Div tag: <div></div>

      The Heading tags: <h1></h1> <h2></h2> <h3></h3>... ...<h6></h6>

      The Paragraph tag: <p></p>

      The Un-ordered List tag: <ul></ul>
      Un-ordered lists, more typically called "Bullet" lists, are lists whose listed items have no particular order to them.

      The Ordered List tag: <ol></ol>
      Ordered Lists are lists with items that must be listed in a set order for the list to make the most sense.

      The List Item tag: <li></li>
      List Item tags define the beginning and end of each item in both Un-ordered and Ordered Lists.

  2. Format:

    • Where possible, an HTML tag should begin and end on the same code line.

      <p>Some text. Some more text. Yet more text.</p>

    • However, when a Block Element Tag contains within it another Block Element, then we use line breaks and indents to show this.

      <div id="content">
          <p>
      Some Text. Some more Text. Yet more Text.</p>
      </div>

    • There are also Logical Indents. This is where a Block Element follows another one in a way that logically suggests an indent; for example, a Paragraph following a Heading.

      <h3>Title</h3>
          <p>Some Text. Some more Text. Yet more Text.</p>
          <p>Some Text. Some more Text. Yet more Text.</p>

  3. Illustrations:

    Figure: 1.2: Complicated example of the use of Indentation from this page.

II. Collecting Mod Data

1. Using a Text File

I like to use a running text file to collect Mod Entry Data.

It works like this:

  1. Open an empty text file in Notepad

  2. Make an entry template.

    Figure 2.1: Mod Entry Template.

  3. Copy and paste it down the page so that you have a dozen or so empty templates ready to use.

  4. Find a new Mod.

  5. Cut and paste the Mod Name, Author's Name, and Discussion Link URL.

    Figure 2.2: Copy and Paste Mod Data.

  6. Download the mod and prepare the new Zip file as shown here: Updating Part 1; Zip Files.

  7. Once you have that done, you should have filled out the last two entry fields in your Mod Data text entry. Each entry should be on the middle of the 3 line breaks to allow plenty of room to easily select text for cutting and pasting to the HTML documents.

    The Mod Data Entry we'll be using in the following example is shown below in Figure 2.3.

    Figure 2.3: Mod Data Entry for Example.

III. Updating the HTML Documents

A. Updating full_list.html

First: if necessary, download the up-to-date HTML documents from the host server. Documentation on using SmartFTP can be found here: Using SmartFTP

  1. Open HTML Kit

  2. Open "full_list.html"

  3. Find the Mod Entry template near the top of the document.

    Figure 3.1: The Mod Entry template in "full_list.html."

  4. Select and copy the Entry Template text as shown in Figure 3.2.

    Figure 3.2: Select and copy the entry text.

  5. Using the entry data from Figure 2.3, find the "full_list.html" alphabetical slot our mod "Example" belongs in using the FIND button and our knowledge of Comment Tags.

    1. Click the FIND button in the top tool bar.

    2. In the dialog box, enter the text string that will bring us to the top of the "E" page division. Then click the Find Next button.

      Figure 3.3: The Dialog box.

  6. You should be at the top of the "E" page division as shown in Figure 3.4.

    Figure 3.4: full_list.html at Start "E"

  7. Scroll through the "E" section top find the exact alphabetical slot for our mod, "Example."

    Figure 3.5: Fine the correct alphabetical slot.

  8. Paste the Entry Template into the slot so it looks like Figure 3.6.

    Figure 3.6: Paste the Entry Template into the slot.

  9. If you haven't done so, open your New Mods text file in HTML Kit along side "full_list.html" and find our new Mod, "Example" in the list.

  10. Now cut and paste each of the entries in the text file to the corresponding entry in "full_list.html" as shown below in a series of illustrations.

    Cut the Mod Name.

    Paste the Mod Name.

    Cut the Author's Name.

    Paste the Author's Name.

    Cut the Discussion Link URL.

    Paste the Discussion Link URL.

    Cut the Mod Category list.

    Paste the Category List.

    Cut the Relative Path entry.

    Paste the Relative Path entry.

  11. And to complete the entry fill in the Titles for the Link text as shown below.

    Fill in the Mod Titles for the Link entrys.

  12. Now save "full_list.html," and we'll move on to the Category Pages.

B. Updating the Category Pages

Once you have the "full_list.html" entry done, the rest is easy. Just open the Category Pages one at time and copy and paste the entry from "full_list" to the Category Pages. See the series of illustrations below for details.

1. Open "armor.html" and use FIND or scroll to the "E" page section and locate the correct alphabetical slot for the entry.

2. Select and copy the Mod Entry from "full_list.html"

3. Paste the entry into "armor.html" and save the file.

Repeat those 3 steps for each Category Page, and then Upload the updated files, and you're done.