About Using This Wiki

From OpenNMS
Jump to: navigation, search

Introduction

The OpenNMS Project Page is a wiki. It is designed to allow you to add content easily to this site, and you are encouraged to help us extend the value of this site by adding your own pages and editing existing ones. Any registered user should be able to modify most pages. If not, please open a bug under "Miscellaneous". This is a community project staffed by volunteers, so please no spam or language that would be considered impolite. Non-English content is welcome, but I will be running it through Babelfish in order to remove phrases like "Tarus is a loud-mouth pig". (grin)

We use MediaWiki to implement this site. Please visit their site for more information on how to use this wiki, but here is a short guide that can help you get started.

Create Wiki Pages

You can use the wiki's URL for creating a new page. The URL to an article of the wiki is usually something like this:

http://www.opennms.org/wiki/Main_Page/ARTICLE

If you replace ARTICLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the "Edit" page tab at the top of the page will take you to the edit page for that article, where you can create the new page by typing your text, and clicking submit.

Wiki Rules

There are some standards which should be followed to keep the wiki structured and cleary.

Tested for version

Equip your wiki article with the OpenNMS tested-with-version banner.

This code:

{{Version:Header}}
{{Version:Tested:v1-12-8 | tester = TBSliver }}
{{Version:Footer}}

looks like:

Tested for Versions
The instructions in this article have been tested against the following versions of OpenNMS.
Tested Against:
Version 1.12.8 tested by TBSliver

Available banners:


Work in progress

To visualize, that a wiki article isn't completed you can you the work in progress template

This code:

{{WIP
  | user   = TBSliver
  | ticket = NMS-6717
}}

looks like:

Work In Progress

This article is a work in progress, and as a result may change without notice.

For more information on the current state of this page, ask user TBSliver or check the Jira ticket: NMS-6717

Last Revision: 05 August 2016 13:50

Categorize Wiki Pages

The OpenNMS Wiki uses the CategoryTree feature to organize all wiki pages at the starting page. To get your wiki page into it you have to categorize your wiki page. At the bottom of your page just add:

[[Category:Name]]

You can use more than one category. It even makes sense! If you write a wiki page about collecting data from Dell servers, the correct categories should be "CollectD" and "Dell". If your wiki contains more content like graph configuration or monitors, it should be also categorized with "Tutorials". The most important categories already exist but feel free to add some new ones.

Existing Categories

  • OpenNMS
    • Community
    • Configuration
    • Daemons
      • AckD
      • ActionD
      • CapsD
      • CollectD
      • CorrelationD
      • DhcpD
      • DiscoveryD
      • Event Translator
      • EventD
      • LinkD
      • NotifD
      • PassiveStatusD
      • PollerD
      • ProvisionD
        • Detectors
        • Provisioning Adapters
      • RtcD
      • ScriptD
      • StatsD
      • SyslogD
      • ThreshD
      • TrapD
      • VacuumD
      • XmlrpcD
    • Development
      • API
      • Featurebranch
    • Getting Started
    • Graphs
    • Hardware
      • 29West
      • AKCP
      • Alvarion
      • APC
      • Cisco
      • Dell
      • Fortinet
      • HP
      • HW-Group
      • Juniper
    • Installation
    • Notifications
    • Maps
    • Other Languages
      • French
    • Reports
    • Security
    • SNMP Graphs
    • Software
      • Apache
      • Asterisk
      • Atlassian
      • GData
      • IBM
      • Jaspersoft
      • Java
      • LDAP
      • Microsoft
      • MSSQL
      • MySQL
      • Nginx
      • NovaTec
      • NSClient++
      • PostgreSQL
      • RRD
      • SNMP
      • Squid
      • Symantec
      • VMware
    • Thresholds
    • Tips and Tricks
    • Tools
    • Trouble Ticketing
    • Tutorials
    • Use Cases



Syntax highlighting

OpenNMS configs are mostly written in XML. To visualize it more readable you can use syntax highlighting. Beside XML there are many other languages supported. You can find a full list on the GeSHi Language support wiki page.

Please use:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
</syntaxhighlight>

to get the xml code highlighted:

<?xml version="1.0" encoding="UTF-8"?>

You can also use

<source lang="Java">
public static void main (String[] args) {
  String foo = "World!";
  System.out.println("Hello " + foo);
}
</source>

to get source code highlighted like here:

public static void main (String[] args) {
  String foo = "World!";
  System.out.println("Hello " + foo);
}

Config file and path names

Config file and path names should be higlighted bold.

For example:

  • poller-configuration.xml
  • /etc/opennms/eventconf.xml
  • /opt/opennms/etc/events/
  • ${OPENNMS_HOME}/etc/datacollection/

To write in bold letters you can use ''' at the beginning and the end of the string.

For example:

  • '''bold'''

back to main page