How to add a new glossary entry

Let's say you want to create a new glossary entry for the word "modem". Here's what you do.

Step 1 -- Read about the wiki

• If you've never created a page on the OSAF wiki, please read WikiSurvivalGuide^?.

Step 2 -- Register

• If you don't have a wiki account, you'll need to register.

Step 3 -- Create a wiki page

• Create a new wiki topic for your glossary term.
  • Find the URL box at the top of your browser. Since you're on this page, it should say http://chandlerproject.org/bin/view/Documentation/AddingNewGlossaryEntries.
  • Replace AddingNewGlossaryEntries in the URL with "Modem", and hit enter.
    • Make sure your page name starts with a capital letter, and doesn't have any two capital letters strung together -- for example, "Osaf" and "OsaFoundation" are both okay, but "OSAF" and "TheOSAFoundation" are bad.
  • On the page that says "This Wiki topic does not exist", hit the "Create" on about the third line (ignore the warnings about the WikiWord). You might need to give your username/password first if you aren't logged in yet.

Step 4 -- Edit the definition

• The newly created page will automatically include text similar to what is shown in the yellow box below. Edit that text to change the definition so that it suits you.

%STARTINCLUDE% 
%OSAF_STARTBACKGROUND%
   * [[Glossary.Modem][modem]] - A modem is an device that uses audio signals to let 
computers send data over ordinary phone lines. 
      * See also: http://www.hyperdictionary.com/computing/modem
%OSAF_STOPBACKGROUND% 
%STOPINCLUDE% 

*Usage:* This is a Chandler-specific term that is always capitalized.

Step 5 -- Fill in the "GlossaryForm"

• IMPORTANT: PLEASE DON'T SKIP THIS STEP
• Below the text box there will be a form name "GlossaryForm".
  • In the field for "DisplayName", type in the name of your term exactly the way you would like it to normally appear. You do not have to use CamelCase here; you can capitalize your term however you think is best, and you can include spaces between words if your term has more than one word.
  • In the field for "GlossaryTermCategories", check all the boxes that apply.

Step 6 -- Add cross references

• Cross References: Cross references lead directly from one heading to other related heading(s).
  • See: references lead from an unauthorized heading to an authorized heading. Think of a See: reference as a redirect.
  • See also: leads from one authorized heading to another authorized heading.
    • See also: references are used to direct the reader to closely related headings.
    • There may be multiple See also: references associated with an authorized heading.
  • See from: references may be used in an authorized heading to indicate the reference from the unauthorized heading.

How to reference a glossary entry

Let's say you're writing some Chandler developer documentation about how to use the new Chandler modem features. You've decided that you should start off with a terminology section that talks about "modems" and "bandwidth" and "telephony" and whatnot. You could just copy and paste the glossary definitions into your terminology section, but a better alternative is to "include" them.

To "include" a glossary entry, use a wiki statement like this:

%INCLUDE{"Glossary.Modem"}%

Here's an example of a page with a terminology section that includes glossary entries: Users And Groups Design^?

.

.

.

.

. ItemS

Contributors

• BrianDouglasSkinner - 10 Feb 2004 to 27 Mar 2004