Contribute Your Knowledge ~ Alternative Approach
The usefulness of this Knowledge Base depends on the content that people contribute to it; either by adding new information, or by editing what already exists. There are very simple ways to get started, or techniques to create more complicated content, whatever you are comfortable doing.
- Changes, FAQs, Titles & Index
- The Knowledge Base is composed of Pages and you navigate from page to page by clicking on Hyperlinks.
- When you edit or add information, you are actually editing or adding Pages, and creating Hyperlinks between those Pages to help people find their way around topics.
- Pages are grouped into Namespaces that are equivalent to directory folder paths on a PC.
- Just like any other website pages, the Hyperlinks can navigate to anywhere on the Internet and can display images and download data files.
- The editor dialogue uses Wiki codes similar to the Forums BBCodes. The popular codes have toolbar buttons, but they all can be entered manually.
- Some are standard Wiki codes, such as pairs of asterisks
**bold**that produce bold text.
- Others rely upon installed Plugins that define Macros, such as
<color red>red text</color>that produces red text.
If you are a newcomer then the following steps will get you started.
- Before you can edit the Knowledge Base Wiki you need to follow the Signing Up For Editing steps.
- Use Tools > Log In via the toolbar top right before each editing session and use Tools > Log Out afterwards.
Easy Ways to Contribute
After creating a page using those forms, it can be customised further by using the editing techniques below.
Edit Existing Pages
To edit an existing page, which you may have created in Downloads and Links or Member Web Sites, or because you found something that needs revising such as a spelling mistake, then use this guide to understand text formatting.
Above all, remember that this is a Wiki and everyone can edit a page if they think it worthwhile. Every version of each page is recorded, so if you do have a problem the administrators here can recover an earlier version.
- Introduction ~ scope and concepts of page editing and formatting
- Edit and Save a Page ~ how to login, edit, preview, cancel, and save a page
- Character Styles ~ bold, italic, underline,
mono, sub, sup,
strike, fh, smileys , special chars ⇒, colours
- Text Layouts ~ paragraph, headline, horizontal line, list, table, box, footnote, hidden text, comment, quote
- Text Formats ~ inhibit formatting, code blocks, syntax highlighting, code downloads
Every Page exists within a Namespace, similar to the way every file exists within a folder path. This guide explains the concepts associated with those features.
Edit Links and Media
These features offer Hyperlinks between Wiki Pages, to the Internet, and to images and downloads.
- Introduction ~ scope and concepts of editing hyperlinks, images and downloadable files
- Links within the Knowledge Base ~ creating internal page links
- Links to External Web Pages ~ creating external page links
- Email Addresses ~ including email addresses on a page
- Link Shortcuts ~ linking to frequently used external resources
- Wiki Backlinks and Indexes ~ creating lists of wiki links
- Images and Image Links ~ embedding images on a page and optionally linking them to other pages
- Download Links ~ creating links to download files
- Media Manager and Media Files Window ~ adding, updating and deleting image and download files
Create and Manage Pages
These guides explain how to create, delete, rename or move Pages within Namespaces, and update cross-references.
- Introduction ~ scope and concepts of Namespaces, and creating and managing Pages within them
- What Sort of Page ~ what Namespaces are there?
- Create a Page ~ create a new page or new subsection
- Delete a Page ~ delete a page (removing backlinks first if necessary)
- Rename/Move a Page ~ rename or move a page
- Alternative Index Entries ~ provide page aliases
- Shared Page Contents ~ include one page in other pages
These guides explain features only of interest to experts and otherwise can be ignored.
- Introduction ~ scope and concepts of advanced editing features
- YouTube Animations ~ video animations
- Control Macros ~ Some of these may be worth adding in earlier sections
- Syntax Plugins ~ What are they and why might you want to use them. (Quote example from earlier of the pushfile plugin).
- Advanced Features ~ Embedding specialist content (HTML, PHP, XML).
Maybe this should be a page within Expert Features and just for links to docuwiki guides as suggested below?
Links to User Guides with notes that they cover material already covered above, but aggregated for convenience. Not sure we need this if all the User Guide pages for all the features are included above?
Links to detailed manuals/docuwiki etc. – the stuff that very very few people will need to carry out routine tasks.
Glossary of terms.