Help:Editing the Help Index

Search WikiTree's help pages:

Categories: Leader Help


Introduction

Finding help documents or a specific place on a website like WikiTree should be three legs of a stool:

1. Search Page: This acts as the same as a concordance would in a book. Put in some key words and you get results... sometimes more results than you need. On WikiTree that is found here:

https://www.wikitree.com/wiki/Special:SearchPerson

2. List of Articles and Categories: In a book this is called the table of contents. On WikiTree this is found here:

https://www.wikitree.com/wiki/Category:WikiTree_Help

Because this is a category page and not a true table of contents articles are listed in alphabetical order. This can sometimes lead to confusion when trying to find a topic. In addition, since it is a category, any user can add articles which can add to the confusion until they are seen and removed. The top of this page is protected and can only be changed by a sysop.

3. Index: Usually found at the back of a book it is what you turn to when the table of contents is too vague or you need something more specific then search will yield. This document is to guide leaders and sysops in suggesting entries for the WikiTree Index. WikiTree's Index can be found here:

https://www.wikitree.com/wiki/Help_Index

Guides for Indexing

1. Keep it simple. You should put yourself in the place of a new WikiTree user looking for information. What keyword would you look under? In the very unusual event that there are two places a user might look then index both of those words. Do this RARELY. If you need a modifer then place it after a comma. Example:

biographies, created by

2. Use nouns not verbs or adjectives. This is one of the most important guidelines for indexing. For example we don’t put information on “closing an account” under “closing”. We put it under “accounts”. Most of us grow up using indexes in books so our life experience has trained us to look for nouns when using any index.

3. Because we are indexing web pages and not pages in a book each keyword gets its own line. If the keyword doesn’t tell the user what is unique about that page use one additional descriptive word with it to make it unique. Brevity is everything.

4. There are three levels of indexing allowed. The third level should not be used unless absolutely necessary. The first level uses capital letters like a tile of a book. Levels two and three always use small case letters. Example:

  • Accounts
    • about
    • active
    • benefits
      • family
      • membership

5. When directing users to see another part of the index always use italics and a colon. Example:

also see: Guides to WikiTree.

If you are directing users to another section on level one do not use the word “also”. Examples of both:

  • Family
    • editing relationships
    • members, adding
    • non-traditional
    • views
    • printing
  • Fields see: Profiles
  • Footnotes
  • Help
    • articles and categories
    • genealogy resources
    • videos
    • also see: Guides to WikiTree
  • Honor Code


6. Separate individual items with a semi-colon. Example:

also see: Date Fields; Name Fields

7. The only projects that we individually index are those that are function based or that could reasonably touch on every profile or user. Examples are: Categories, Mentors, Arborists, etc.

8. In our index “WikiTree” is used specifically to refer to those pages that are about the company. No other pages belong under that entry.

Formatting the Help Index

Simply add a " * " before the links to pages or categories on the first level.


What you type:

* Example 1
* Example 2
* Example 3

What it looks like:
  • Example 1
  • Example 2
  • Example 3

Add an extra '*' to go the second and third levels, like this:


What you type:

* Example 1
** Example 1a
** Example 1b
*** Example 1c

What it looks like:
  • Example 1
    • Example 1a
    • Example 1b
      • Example 1c
Language: en | nl


This page was last modified 11:09, 28 March 2018. This page has been accessed 85 times.