Cacti (home)ForumsDocumentation

Scripts Guidelines

Script Creation

Script Namespaces

User submitted script pages can be created by simply entering http://docs.cacti.net/userscript: followed by the name of your script. ie: http://docs.cacti.net/userscript:my_new_script

Script Defaults

When creating a script page for the first time, it is automagically populated with a standard set of defaults. Please complete as many of the sections as possible to maintain the site standard.

Script Data Entry

The very first section of the Script_Defaults is the Data Entry area. Completing this section will allow for the script to be listed on the Scripts page.

Sample Data Entry

---- dataentry plugin_style ----
type:userscript <-- do not change
userscript_nspage:my_new_script <-- do not change format
author_page:wiki:user:my_name
description: A valid description 
version:1.0.0
homepage_url: http://example.com
date: 2009-01-30
email: my_name@example.com
license: GPLv2
scripts_tags: syslog
----

Template Tags

At the very bottom of the Scripts_Data_Entry after 'scripts_tags', you can enter tags that will allow for filtering via the 'tag cloud' at the top of the Scripts page

Attempt to make these tags as generic as possible, while still retaining meaningful information. For example, 'syslog' is sufficient, 'capturing, syslog, wicked cool, damn near magic' is unnecessary.

Note: All tags should be in lowercase to avoid duplication of tags.

Script Deletion

Remove everything in the page except for DELETEME ( DELETEME ) and the admins will purge it.

If there is a file attached to the page, leave the link to the file and place DELETEME beside it.

In 'Edit Summary' ensure you enter DELETEME as it will make it easier to find under Recent Changes.






Personal Tools