Help:Contents
Contents |
Introduction to editing
What's different about this website?
The Information and Knowledge Resource Kit (IKRK) has been developed as a 'wiki' website. A wiki is a collaborative website that can be edited by anyone who has access to it. If you're new to wikis, here's a fun 4-minute explanation from Commoncraft Paperworks. Another well-known wiki website is Wikipedia,
Who can edit the IKRK?
Only Knowledge Leaders are able to edit this IKRK wiki website.
How do Knowledge Leaders edit the IKRK?
Two simple resources have been developed to help Knowledge Leaders with the common IKRK editing tasks. Please use both of these resources together:
- IKRK Editor's Guide, which is available by contacting the Australian River Restoration Centre (ARRC); and
- Help for editors sections below.
Alternatively, any Knowledge Leaders who would like to get into some advanced editing may wish to visit Wikipedia's help. The IKRK uses the same software as Wikipedia, and Wikipedia has detailed articles covering almost every imaginable aspect of editing. Wikipedia also has a group of volunteers who answer questions and provide help with editing.
Help for editors
Please use the information below in conjunction with the Editor's Guide available by contacting the Australian River Restoration Centre (ARRC).
Uploading Files
Templates have been created for uploading files which show links to the file and appropriate icons.
To use these templates, which enable files to be shown as links with relevant icons, as well as a link to the file's wiki page, see here.
Here is an example of how the template appears: 
Example File 
Working with images and other uploaded files
Uploading images is a little bit more complicated than other files because of the number of options available for layout formatting, such a alignment, adding thumbnails etc.
The Wikipedia help has a great summary of how to work with images.
What if I am trying to upload an image or file and all I get is this error messege
"." is not a recommended image file format.
You need to specify the file extension in the "Destination Filename" field. i.e. don't specify "MyImage", use "MyImage.JPG"
Naming articles
The name of the article is at the same time the article headline as well as the link for the article. The first character is always automatically capitalized. Lowercase second and subsequent words, except if it's a name. Prefer singular nouns. Use spelled-out phrase and use redirect for acronyms and abbreviations.
The following characters are not allowed in page titles: \# + $<$ $>$ [ ] $\vert$ $\{$ $\}$ /. The first character is automatically capitalized. The maximum length is 255 characters.
For more information see Wikipedia naming conventions
Templates
The MediaWiki software used behind the Information and Knowledge Resource Kit offers the capability to automatically generate sophisticated HTML using templates. Templates should be discussed before being created or modified. The list below shows most of the templates that are currently available, with brief explanations of how and where to use them. To see a list of all IKRK templates go to the all pages list, then in the Namespace box near the top of the page select 'Template' from the drop-down list and then click 'Go'.
| Wiki Markup | Purpose | Template Display | ||||||
|---|---|---|---|---|---|---|---|---|
{{pdf|filename|link text}}
|
Displays a pdf icon, and a link to information about the uploaded file. You should use this template when uploading pdf files. | Sample File
| ||||||
{{doc|filename|link text}}
|
Displays a doc icon, and a link to information about the uploaded file. You should use this template when uploading doc files. |  Sample File
| ||||||
{{ppt|filename|link text}}
|
Displays a ppt icon, and a link to information about the uploaded file. You should use this template when uploading ppt files. |  Sample File
| ||||||
{{xls|filename|link text}}
|
Displays an xls icon, and a link to information about the uploaded file. You should use this template when uploading xls files. |  Sample File
| ||||||
{{audio|filename|link text}}
|
Displays an audio icon, and a link to information about the uploaded file. You should use this template when uploading audio files. |  Sample File
| ||||||
{{txt|filename|link text}}
|
Displays a text icon, and a link to information about the uploaded file. You should use this template when uploading text files. |  Sample File
| ||||||
{{mov|filename|link text}}
|
Displays a movie icon, and a link to information about the uploaded file. You should use this template when uploading .mov files. |  Sample File
| ||||||
{{subst:howto}}
|
Boilerplate for creating a new howto article in a standard format. The substitution text can be used to quickly insert the article template into newly created articles. When the article is saved the shortcut is replaced with the text. This is a one-off substitution and can only be undone by deleting the inserted text - use with care. | See the Howto template | ||||||
{{infobox|title|description}}
|
Used to create an infobox to display an interesting fact or notable piece of information within an article. Infoboxes should be used sparingly. |
| ||||||
{{newsitem|title|date|description}}
|
Used to create a news item in the "News" box on the home page. | title
date description (more...) | ||||||
{{profile
| name= Your Name
| image=[[Image:Pretty.jpg|noframe|250px]]
| title= Your Position Title
| organisation=Your organisation
| website=http://yourorg.com
| email=mailto:youremail.com
}}
|
Used to create the profile box for User pages (and should not be used anywhere else). All arguments to the command are optional. For the image argument, please make sure the width is exactly 250px (the width of the quickbar) and that the "noframe" option is specified. |
| ||||||
How to contribute News items
This section is under construction
The 'News' section of IKRK has three components:
- News box on the home page of the IKRK. The News box features two news headlines and a short line of text for each headline, and each of these ends with a link for '(more...)' details. The format of the News box, including the '(more...)' links, has been created through the use of a template. Through the use of this template, clicking on the '(more...)' links automatically goes to the exact part of the News page corresponding to the particular news headline. There is more information about templates above, and the News box template can be viewed here (this template should not be changed).
- News page that people go to when they click the link the '(more...)' links in the News box on the home page. The News page has two small to medium sized articles corresponding to the News box headlines.
- News archive. The News archive features all of previous news articles from the News page. The News archive is accessed from the link in either the News box or News page.
Adding news items is one of the more complex IKRK editing tasks, but it can be done successfully by carefully following these steps (and once you know the process, you will be able to do it very quickly):
- Open the IKRK in a second web browser tab or window. Keeping this page open, open the IKRK in a second web browser tab or window. Having the two windows/tabs open will enable you to read these instructions in one window/tab while editing the news components in the other window/tab.
- Login. In the other tab/window, login as an IKRK Editor. All of the subsequent steps below will happen in the other tab/window.
- Familiarisation. Familiarise yourself with the three news components as described above (News box, News page and News archive).
To add a news item you must edit all three components (and the News box on the home page isn't the first component that you will edit). Click through the three components noting how each of them should appear when you have finished editing. - Archive the News page. Before adding news, you must archive the current news items on the News page (not in the News box on the home page - don't edit this until later). To archive the current news on the News page:
- Go to the News page (which you can access by clicking one of the '(more...)' links on the home page).
- Click the 'edit' tab at the top of the News page.
- If you intend to add only one news item, you will only be archiving one of the news items on the News page, and this will be the bottom one. If you intend to add two news items, you will be archiving both of the news items on the News page.
- Select the headline, date and article text of the bottom article or both articles but do not select the NOTOC command at the top of the page or any of the 'More news' heading and section at the bottom of the page. If you have selected either of these, do the selection again.
- Right mouse click and select 'copy' (not 'cut').
- Click 'Cancel' at the bottom of the page (you don't want to change this page yet).
- Click on the News archive link in the 'More news' section at the bottom of the page.
- Click on the link for the date range that corresponds to the date of the news items you are archiving (if there is no corresponding date range, you will need to create a new page for a new 6-month date range following on from the previous date ranges - see your IKRK Editors Guide for information on how to create a new page).
- Click the 'edit' tab at the top of the page for that date range.
- Then paste the news item or items you copied from the news page above the previously archived news items shown on this page (these pages list the most recent news items at the top of the page).
- Then click 'Show preview' at the bottom of the page and make sure that the items you have added display properly (including headline, date and article text) and are spaced correctly from the previously archived items further down the page.
- If the 'Page preview' is okay, click 'Save' at the bottom of the page, or if not edit the text, then select 'Page preview' and repeat until the text is correct and can be saved.
- Edit the News page. Now you will add your news item or items to the News page (not to the News box on the home page - don't edit this until later). To add your news to the news page:
- Go to the News page (which you can access by clicking one of the '(more...)' links on the home page).
- Click the 'edit' tab at the top of the News page.
- If you had archived just the bottom news item, now select it (including headline, date and article text) and delete it. The other article on the page, which had previously been the top article, will then become the bottom article. Add your news item above the other article using exactly the same formatting for the headline, date and article text.
Alternatively if you had archived both news items, just edit them to change the headline, date and article text of both so that they become your news items, making sure that you don't alter any of the formatting.
The headline should not be any longer than 12 words.
Do not change the NOTOC command at the top of the page or any of the 'More news' heading and section at the bottom of the page. - Then click 'Show preview' at the bottom of the page and make sure that the items you have edited display properly (including headline, date and article text).
- If the 'Page preview' is okay, click 'Save' at the bottom of the page, or if not edit the text, then select 'Page preview' and repeat until the text is correct and can be saved.
- Edit the news box on the home page.
- Go to the News box on the home page of the IKRK (which you can access by clicking on the IKRK logo in the top left of any IKRK page).
- Click the 'edit' link in the top right of the News box.
- You will notice that this page has special formatting. This formatting relates to the template. It is most important that you do not alter any of the formatting on this page, or the News box will not function correctly.
- The safest way to edit the News box is to not cut or copy anything. It's best to just change the wording of the headlines and dates to match the updated headlines and dates on the News page, and then edit the short line of text that goes with each headline to match the updated news items on the News page.
This short line of text should be no more than 18 words in length and should be worded to get the readers interest and make them want to click the '(more...)' link.
Make sure that the top headline in the News box corresponds to the top article on the News page, and the bottom headline in the News box corresponds to the bottom article on the News page (if they aren't in the same order the '(more...)' links won't work properly).
Citing references
Usage
The basic concept of the <ref> tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section, which you indicate with the placeholder tag <references />.
If you forget to include <references /> at the end of the article, none of the footnotes will appear.
This page itself uses footnotes, such as the one at the end of this sentence.[1]
Example
According to scientists, the Sun is pretty big.<ref>E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.</ref>
The Moon, however, is not so big.<ref>R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.</ref>
==Notes==
<references/>
Notes
- ↑ This footnote is used as an example in the "Citing references" section.
