How to contribute

From The CA Plex Wiki

Jump to: navigation, search

Contents

Adding to an existing page

Before writing your own article in the Plex Wiki take a few minutes to search and browse for similar articles that could be enhanced with the information that you intend to add. Getting to know the existing pages and category definitions will help when writing and categorizing your own articles. If you do not find a suitable article for your topic then you will need to create a new page.

Creating a new page

Wiki pages do not exist as part of the database until content has been typed into them and the page is saved.

For example this link should point to a Blank_Page (provided nobody else has edited it).

To create a new page first add a link to any existing page and save or preview the change.

The syntax for a link is [[name of the new page]]

Click on the new link to access the editor for your new page.

Editing the page

Use the editor to add some content to the new page before saving the changes.

Now that the new page has been saved it can be accessed and updated by you and other Wiki users.

If you don't wish the new page to be linked from other pages at this stage you can discard the changes made to the existing page. Alternatively make use of your own "my talk" page which is separate for each profile. These are good techniques to keep your page behind the scenes until you have finished drafting it.

Take a look at this help page for a full explanation of creating new pages Wiki Help Create Page

Formatting the page

This is a brief synopsis of common Wiki syntax. Comprehensive guides can be found all over the web, the main reference for the MediaWiki product is: WikiMedia Help

Headings

Headings use a pair of equals signs on either side of the text. Additional characters are added to increase the depth of the heading. The more characters, the further down the hierarchy the heading will be. ==Heading1==

===Heading 1.1===

Text

===Heading2===

Text


Adding heading to the page will create a table of contents at the top of the page.

Text

Typing standard paragraph text requires no special markup.

Paragraphs must be separated by a blank line.

Or the next line will be appended. Like this one was!

If you wish to turn off the Wiki processing for a section use the

<nowiki>Don't format this</nowiki> tags.

The <code></code> is a useful tag for entering fixed format text, such as source code.

    function onType(formObject) {
         var len = formObject.cc_no.value.length  1;
           
         //insert a dash at these positions
         if ((len % 5) == 0) {
              formObject.cc_no.value = formObject.cc_no.value   " ";
         }
    }

Links

Just like the web, a Wiki relies on linking one page to another.

Links can be made to other pages within the Wiki using square braces CA_Events [[CA_Events]].

Other websites can be referenced using the full URL followed by an optional description [http://wiki.2einfo.net 2e Wiki] 2e Wiki.

Pictures

Pictures can be displayed as part of your page. The image file must first be uploaded into the Wiki database using the Special:Upload page. Once part of the Wiki the image may be referenced in the same way as any other link, use the full name of the file prefixed with the "Image:" qualifier to display the picture on the page.

[[Image:Plex Wiki.PNG]]

Plex Wiki.PNG

Use of language

The tool we are writing about is known as Plex, When writing your page you can use the name "Plex" and most people will know what you are talking about.

If you want to use the product's current full name then it is "AllFusion Plex" not "All Fusion" or any other derivation.

CA is "CA" not "Computer Associates"

Categories and navigation

A Wiki is a collection of pages which may reference each other. There is no defined hierarchy or menu structure to which pages are added. Instead each page is tagged as a member of one or many categories. Correct use of categories is the main driver for a Wiki as it allows related pages to be associated without additional housekeeping. Categories also permit Wiki navigation to remain up to date when new pages are added.

The categories within the Plex Wiki can be seen on the Special:Categories page. Using just the list of categories it is easy to begin browsing the information within the Wiki. Categories which are members of other categories are called subcategories. They link to other categories and pages which in turn contain pages that link to other pages and other categories.

Categories follow the same rules as every other object in the Wiki, they do not exist until they have some information to store. In the case of categories the information is a list of the pages which are a member of category.

The main page of the Plex Wiki has been edited to display the main top level categories. The category Category:Plex_Development_Environment contains 4 subcategories and one article. The article is the original navigation page from an earlier version of the Wiki. In order for the page to remain upto date it would have to be manually edited as new articles are added. The corresponding category page does no have this problem, demonstrating the benifit of using categories.

When creating a new page it is best to select one or more subcategories that describe the contents of the article. Subcategories need not be related or members of the same category, in this way it is possible to to tag article as Category:Windows NT Server and Category:Communication Technology

Always aim to use the most appropriate sub-category or sub-categories for your article. Using a sub-category automatically includes the article as part of the parent category.

The WikiMedia help has an full article on categorizing a page [1]

Personal tools