PhUSE Wiki

Each Wiki should contain a specific topic (or sub-chapter of a higher level topic as in the GP section).

It contains a separate depository for documents and code snippets related to the topic of interest. Additionally it's linked to the PhUSE Discussion Forum where content can be discussed without having an immediate effect on the Wiki itself.

The chosen content should fit into one of the main sections, i.e. Good Programming Practice, Derivation Standards or Output Templates. It's also possible to cross-link the Wiki with all of them (e.g. the Wiki for Wiki Enhancement Suggestions).

You need to be a registered user (no membership required) and logged in.

Go to the main Wiki page and select "New Wiki" here

This will take you to the next step, where you can specify the Wiki name, status, template chosen etc...

The title will be the Wiki title you'll see displayed on the homepage and which will be searchable in Google (so choose it wisely!).

The Status offers following options:

- Draft (this will only be visible by users who are logged in)

- Open (can be seen by any person browsing the webpage)

- Locked (locked Wiki version, can't be changed)

- Template (use this in case you want to create a Wiki Template for further Wikis)

The section headings provide you the structure with heading links for your Wiki. Don't worry if you don't now all the section headings in advance, they can be added later on.

After choosing the category you can submit the new Wiki and start editing it.

You can update a Wiki in several ways

• You can edit sections within the Wiki itself
• You can discuss the content in the forum (simply click the link and on you go)
• In case you want to add a document, or code snippet, you have that possibility too

The sections below will provide you more details for each of these. 

The text editor is quite straight forward and offers you an interface which is commonly used by standard editors.

For html savvy users, there is a possibility to edit text directly in html code by changing the tab on the bottom of the editor.

Once you're happy with the content, press "Submit Changes" and the change proposal will get reviewed by a wiki administrator (and hopefully approved and therefore made visible to the public).

Adding a link is straightforward.

Simply click the icon  on the editor toolbar which will enable you to add the URL and title of the link.

You have the possibility to directly add

- documents (as a link, which will open the document in a new window)

- graphs / images

directly into the text.

Adding a Document

Click the icon  on the editor toolbar which will take you to the website document library.

You can filter by category and easily spot your document in case it's already loaded into the library.

In case you want to use a new document, you first will have to upload it into the library by clicking "New Item", provide the location of the document and choose the category you want to save it under.

After that you simply click "Insert" to add it into the text. The document will appear as a link with the document name.

Inserting an image / graph

Click the icon   right besides the document icon, this will take you to the images library. Proceed the same way as discribed in the paragraph above for documents.

The image will be inserted directly into the text.

On top of each Wiki, you can see the 5 Wiki Areas already mentioned

Clicking the Snippets Link will take you to the code snippets library. You'll be able to choose from an existing Snippet Category or create a new one.

To add a new code snippet, you'll have to enter some information which will help the user community to make better use of it and search for it:

As you can see above, a specification of the code language, a description of the code, keywords and optional metadata will be useful information for the user community.

For documents, you can proceed the same way by choosing the "Documents" section to store large files in the document depository (alternatively you can also insert a link as described in the previous chapter above).

The PhUSE Discussion Forum is closely linked to the Wiki to enable discussions on Wiki topics that don't necessarily have to directly influence the content. You can subscribe to a "Forum Room" linked to a specific Wiki that will send you an update everytime somebody posts a comment or reply to your entry.

To enter the forum you simply click the Forum Icon on top of each Wiki.