Guide for NENAWiki Editors

From NENAWiki
Jump to: navigation, search

Overview

Background

The NENA Master Glossary of 9-1-1 Terminology is a PDF document that contains acronyms and terms developed as a result of the production of NENA standards, requirements, information and other types of documents. When these documents introduce and define terms or use acronyms, they are included in one or more tables in each document, if they are 9-1-1 specific terms. These terms and acronyms are then incorporated into the NENA Master Glossary of 9-1-1 Terminology which is updated from time to time.

The Glossary section of NENAWiki is intended to provide another way to manage and access the same content found in the NENA Master Glossary of 9-1-1 Terminology. The additional features available with the NENAWiki version include:

  • On-line access from a variety of devices including computers, tablets, and smart phones.
  • Much more frequent updates to allow content to be available soon after NENA documents are published or sometimes sooner, when new terms are proposed.
  • More extensive use of hyperlinks to connect related content pages and to relevant published NENA documents and to other glossary entries.

How do terms, abbreviations, acronyms and articles get into NENAWiki?

Terms introduced or modified with published NENA documents.

When a NENA document is published, any new terms or acronyms that are listed in the document's glossary or acronym table(s) are candidates for inclusion in the glossary. In some cases, a new definition for a term already in the glossary is approved when a document is published. In those cases, the existing NENAWiki definition is edited to match the document's revised definition.

Approval of a NENA REF (Reference) document for the creation of a NENAWiki article.

The deliverable of a NENA REF document may be a NENAWiki article. The NENA process for creating reference documents may be used to create a NENAWiki article. That process would result in the addition of one or more NENAWiki pages. The process should also identify a date for the review of the material to consider whether the article should be updated or removed from NENAWiki.

What kinds of terms and acronyms should be added to this glossary?

The NENAWiki glossary is not intended to provide definitions for common terms, acronyms, or abbreviations. Generally, common terms that are more extensively defined or described in other references (like Wikipedia) should not be included in the glossary unless they include hyperlinks to NENA documents where they are used or discussed in a 9-1-1 context not likely to be mentioned in other public references. For the convenience of the reader, some common terms that have been in the glossary for some time may remain in the glossary but if better definitions are available elsewhere, links to those definitions should be provided. The NENAWiki glossary is primarily intended to provide definitions for terms that are uniquely used in the 9-1-1 community, especially those used in published NENA documents.

The terms, acronyms, or abbreviations that should be included in the glossary should have at least one of these characteristics:

  • They have a definition or usage unique to the 9-1-1 community.
  • They have several possible meanings but are expected to be used in a consistent way in NENA publications.
  • They may have a common, popular definition, but are used consistently with a unique or specific meaning in NENA publications.
  • They have an important use in a published NENA document, and the glossary provides hyperlinks to the document where the term is discussed.

Terms, acronyms, and abbreviations that should NOT be included in the Master Glossary include those with these characteristics:

  • They are only expected to be used in one document.
  • They do not have a definition or usage unique to the 9-1-1 community.
  • Other public references provide good definitions.

Note: When adding terms to a document's Abbreviations, Terms and Definitions table document editors should check the NENA Master Glossary (or wiki) to ensure a term is not already defined. Do not create acronyms or abbreviations unless necessary. If there is an abbreviation that is specific only to your document, instead of creating yet another abbreviation, just spell it out.

Who can edit NENAWiki articles?

NENAWiki article pages (the "Page" tab) may only be edited by members of the NENAWiki's Editors group and Administrators group. NENAWiki talk pages (the "Discussion" tabs) can be edited by Editors, Administrators, and registered Users who have registered on NENAWiki with email confirmation.

Who are NENAWiki Editors and how do you get to be one?

NENAWiki Editors are volunteers who are interested in contributing some time to improving the contents of the NENAWiki glossary. They may (or may not) have subject matter expertise in specific areas. They DO have skills in English, organization, and writing. They like to explain difficult concepts to others. They may have enjoyed working in a library.

Anyone interested in contributing material here should contact the NENA Committee Resource Manager.

Do NENAWiki Editors have conference calls?

We hope not. Except for possible introductory training on how to do the things described on this page, we believe NENAWiki Editors can contribute at times that are convenient for them.

Our goal for Editors: Improve the accuracy, value, and utility of NENAWiki. Here are some of the things that need to be done.

Here are some of the tasks for Editors that would improve the value and utility of NENAWiki:

Add new or modified terms and definitions from NENA documents that have been approved for publication.

Published NENA documents may have glossaries that include new terms and definitions that are designated for addition to NENA's Master Glossary. In some cases, the terms may already be in the Master Glossary and in this wiki but the approved document calls for a modification in the term or its definition. NENAWiki Editors may add or modify wiki pages as shown in the approved documents.

Add "Relevant NENA Documents" Hyperlinks

  • Add references to Glossary terms that link to NENA documents where the terms are more fully defined or explained. An example of a page with such references is ALI Request. The process of adding good references involves:
    • Searching NENA's documents for the term. NENA.org has an excellent search function to help with that.
    • Looking at the document's text to see if the term is more fully defined or explained.
    • Adding the link to the Glossary page using the formatting used in the ALI Request example.
Here is the format for the Relevant NENA Documents section. Try not use the link that downloads document directly. Instead, use a link to the page on NENA.org that describes the document and has the download link to the current document, usually at the bottom of the page.
== Relevant NENA Documents ==
Hyperlink to document page on NENA.org

Add Internal Hyperlinks

  • Add hyperlinks in Glossary page definitions to terms defined on other pages. An example of a page with two such links is LPG (Legacy PSAP Gateway).

Add articles approved by the NENA REF (Reference) document process.

These articles would be added as defined by the NENA REF document. No substantive edits should be made to the material without Administrator approval. Appropriate internal hyperlinks should be added.

Search for "ToDo" comments

Comments (both visible and hidden) are placed where something needs to be done. They contain the text "todo", so if you search for that term, you will get a list of pages with things that need attention.

Getting Started

It's very easy to edit the contents of a wiki:

  1. Click the Edit tab at the top of the page.
  2. Use VisualEditor to make changes to the text.
  3. Click the Save changes button when you want to save the edits you made.
  4. You will see a box where you should describe why you made the edits.
  5. Click Save changes in the box.

It's also easy to create a new page:

  1. Type the complete title of the page you want to create into the search box. That's a good thing to do anyway, in case there is already a page with that title...
  2. When the wiki cannot find the search term, it will provide a link that says: Create the page _____ on this wiki!
  3. Click on the link and a new page will be created and you'll get an edit window for that page.

Editing rules, editing conventions, and formatting

  • The number one rule of wiki editing is to be bold. Go ahead - make changes. Other people can correct any mistakes you make, so have confidence, and give it a try! There are all kinds of editing conventions, rules, and philosophies for the editing of wiki pages, but the "be bold" rule is the most important of these!
  • An edit can contribute whole new paragraphs or pages of information, or it can be as simple as fixing a typo or a spelling mistake. In general, try to add or edit text so that it is clear and concise. Most importantly, make sure you are always aiming to do something which improves the contents of the wiki.
  • When you need to use some type of formatting, such as for a new headings or bolding of text, you do this using wiki syntax or the buttons in the Edit toolbar above the editing zone. See MediaWiki's Help:Formatting for some of the common types of formatting used.
  • It is also useful to simply look at examples of what you want to do in this site or in Wikipedia, and simply copy the formatting. All formatting on MediaWiki sites is visible and may be copied.

Good resources for editors:

Using VisualEditor:

https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide

General Help:

http://www.mediawiki.org/wiki/Help:Contents

Formatting:

http://www.mediawiki.org/wiki/Help:Formatting

Links:

http://www.mediawiki.org/wiki/Help:Links

View History: What is all that stuff?

Here's a good video that explains the View History tab: https://upload.wikimedia.org/wikipedia/commons/c/c6/Using_the_view_history_tab_on_Wikipedia.webm

Some Tips

Renaming Pages? You can't do it. Here's what you do instead -

You cannot directly edit (or rename) page titles. Instead, you "move" pages. The effect is the same. Here are the details: http://www.mediawiki.org/wiki/Help:Moving_a_page

Highlighting Text?

Here's the code for highlighting text:

<p><mark>Highlighted Text</mark></p>

...and the result:

Highlighted Text

How to enter footnotes (called "citations" here)

There is an extensive help for the way citations are set up here: https://www.mediawiki.org/wiki/Help:Extension:Cite

An example of how it is done is on the ASL (American Sign Language) page.

How do you do tables?

Adding and editing tables using VisualEditor is much easier. Here is the VisualEditor guide for tables.

You may also use a utility like one of these to convert a selected set of cells into wikitext.

http://tools.wmflabs.org/excel2wiki/index.php (This link may not work in Chrome but seems to work in Firefox and Edge)

http://www.hifi-remote.com/excel2wiki/index.php (This link seems to work on Chrome, Firefox, and Edge).

For help with additional table options such as color, style, etc., see https://www.mediawiki.org/wiki/Help:Tables

Colors

Color guide: https://meta.wikimedia.org/wiki/Wiki_color_formatting_help

Lower case for the first character in a Title

Mediawiki software normally capitalizes the first character in a title, even if you enter it in lower case. If you really want the first character to be lower case (as in "ecrit" or "i3")), include this text (with the braces) in the article: {{Lowercase}}. It can go anywhere, but if you put it at the bottom of the page, it is easier to find.

If you are using the wikitext editor, simply insert the text as shown.

If you are using the VisualEditor, select "Insert" on the menu and select "Template". Type "Lowercase" in the box, and click "Add Template". On the next box, click "Insert". You do not have to enter a Field name. A quick way to enter a template is to start typing "{{". Visual editor will pop up the enter template box.