Help:Contents/Editing: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
Line 82: Line 82:


===Lists===
===Lists===
Simple lists with bullets are produced by starting the paragraph with a * symbol.  For sub-sections use multiple symbols. 


Number lists start with a # signs
Simple lists with bullets are produced by starting the paragraph with a * symbol.
 
Numbered lists start with a # signs (the Wiki then adds numbers, not you)
 
You can add further * or # symbols after the first to create indented further bullets or numbered sub-lists


Indent a paragraph by starting with a : symbol
Indent a paragraph by starting with a : symbol


==Creating a new Wiki page==  
==Creating a new Wiki page==  

Revision as of 08:25, 11 April 2021

Remember: In the Cumulus Wiki you can only edit/create pages if you are Registered and Logged in.

Creating a new page

The simplest way to create a new page is to search for the topic. If there are no pages which satisfy you then use the 'Create this Page' option at the top of the search results page.


Editing a page

If you wish to edit an existing page simply search for it and then click the 'Edit' tab at the top.


Wiki formatting

When writing for a Wiki there are a number of formats you can write in. The most common, and preferred method, is Wiki Markup or WikiText. This is simply text with a variety of symbols to quickly produce consistent and navigable pages. In the following sections you will learn the basics of WikiText. This is a very powerful markup language however what is detailed below is a good starting point.

In addition to WikiText you can write part or all of the page in HTML, PHP, Javascript and a few other languages. Where ever possible use WikiText as it is the most efficient for delivery and formatting. After a few minutes of writing a page you will be familiar with the basics.


Plain text

This will be the bulk of your page and you simply type as you would read, with sentences, punctuation and paragraphs.


Formatting your text

Itallics

Two apostrophes either side of your text will italicise it.

Example: This should have the last word in ''italics''
Result: This should have the last word in italics

Bold

Three apostrophes either side of your text will make it bold.

Example: This should have the last word in '''bold'''
Result: This should have the last word in bold


Use five apostrophes either side to bold and italicise.
Four apostrophes does nothing!

Underline

use the HTML markup for underline. <u> tag at the start and </u> at the end of your word of phrase.


New Paragraphs

To start a new paragraph simply press the Return key as you would in any editor. If you wish to force a further paragraph use <br/> at the end of the line.

Creating Sections

If you are writing anything longer than a few paragraphs there will be a good chance that it reads better if split into sections and a table of contents at the top (as with this page). WikiText will automatically create the sections, deal with all the formatting and create the table of contents at the top of your page. All you need do is mark your headings appropriately.

Start your Section name on a new line, with two equals symbols and end the section name in the same way.
Example....

==Weather Stats==
Normally text, and short paragraphs

==Historic Facts==
More text

Create sub-sections by using more equals signs.
Example....

==Weather Stats==

More text, and short paragraphs

===This Year===

this years data

===Last Year===

Last years data

==Historic Facts==

More text


If you create more than three sections, the Wiki will automatically generate a contents page at the top of the page.

Lists

Simple lists with bullets are produced by starting the paragraph with a * symbol.

Numbered lists start with a # signs (the Wiki then adds numbers, not you)

You can add further * or # symbols after the first to create indented further bullets or numbered sub-lists

Indent a paragraph by starting with a : symbol

Creating a new Wiki page

All Wiki page names always start with a capital letter, and the Wiki will always replace an initial lower case letter with the equivalent upper case letter. You can choose the case of subsequent letters, but these must always be specified in any references to the page exactly as when the page was created.

It is easier for the reader to find information on multiple short pages, than have to read a long page. Think carefully about page names; if you use a word like "New" in connection with a feature added in a particular release, will the contents remain "new" for evermore, or will they become "standard" when older releases are forgotten. In general, page names should be kept short, but if a topic is split over several pages, each page name must make it clear what is on that particular page.

The web page name you choose will form part of a URL https://cumuluswiki.org/a/'''new_page_name''', so it is normal to place underlines between words in a page name (because spaces cannot appear in a URL, and would be replaced by the messy "%20" code).

To create a new page, there are two ways:

  1. When you feel you have enough on the current page simply enclose the proposed name of the page in double square brackets [[.....]] in a cross-reference on an existing page.
    • A link to an internal page name that does not exist, will appear in red on the existing page. Clicking that link will take you (or anyone else) to a new screen where you can create the new page.
  2. Go to the URL box in your browser, and replace the name of any existing page (that you are reading, not editing) with your proposed new name, then go to the URL.
    • A screen will appear saying that you have linked to a page that does not yet exist (or has exited before and been deleted), saying that if you type in content then the page will be created.

Be careful a reference to (for example) [[webTags]] would create a new page, as that capital T in the middle is different to the name of the existing Webtags page.

Cross references to other Wiki pages

You may wish to refer the reader to information on other pages to further expand their knowledge or explain something in more detail. If you are referring to another page already in the Cumulus Wiki simply enclose the name of the page is two square brackets (just as advised above to link to a new page). If you wish to show a different word or phrase that will mean more to the reader, than the page name, use the | symbol after the page name and then type the phrase you want the reader to see (this latter approach is also used where you want to replace underlines in the page name with spaces to make it look better to the reader):

Examples: [[Webtags]] and [[Webtags|Cumulus web tags]]

In the first example, if the reader clicks on the word Webtags they will be taken to the page of the same name. In the second case, the user will see the words Cumulus web tags but when they click it will take them to the Webtags page. Be careful with the case of the page name when linking in Wiki. The case of the first letter does not matter, so linking to [[webtags]] or [[Webtags]] is the same as Wiki will always uppercase the first letter.

Remember, the case of all letters except the first does matter, and if you do not match the original page name, the Wiki will think you want to link to a page that does not yet exist.


Creating a link to an external page

if you wish to link to a page outside the Cumulus Wiki, such as a post on the support forum, enclose in one set of square brackets: the full URL, a space, and then a descriptive phrase.

Example: [http://www.google.com Google]

The reader will see the word Google but on clicking that they will be taken to an external page.

Using images

If you wish to include an image in your page, you must first upload the image to the Wiki. You can then refer to it with your text.

To upload the image, use the Upload file option in the toolbox in the navigation bar on the left. Once uploaded you may insert your image on your page using the the square brackets, the word 'file:' and the filename. Example [[File:map.jpg]]


Identify your updates to others

The Cumulus Wiki keeps a historic copy of every change on every page of the system. Before you save your page, take a moment to complete the Summary box at the bottom and explain why you edited the page. If this is a minor edit tick the box. A minor edit would typically be you fixing a typo, spelling error or layout problem. Major edits are new content, updated content, etc.

We log who changed the page and when so your username will appear on the 'History' tab.


Editing Tips

  • Always Preview your work, refine, and preview again before saving.
  • If you are not sure how to do something in WikiText, look at another page and 'View Source' (if you are not logged in) or Edit the page (but do not save) to see how someone else has formatted a page. (Tip - Open a second browser window)
  • User your own user page to experiment. Click on your name at the top of the screen and edit your own page.
  • Don't over save as the system retains a history of every save. Save only when your article/edit is complete.
  • A few of the pages on the Cumulus Wiki are protected and only editable by Administrators. For example, the main page, help, disclaimer, etc. The majority of pages are fully editable by registered users.

Further Help

Full and extensive help is available on the MediaWiki software page under Editing