5,838
edits
Help:Contents/Editing: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Templates: new
(Styling rules section added, Renaming and redirect sub-section added) |
m (→Templates: new) |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
*Keep pages to a reasonable length | *Keep pages to a reasonable length | ||
**Split documentation into separate pages whenever possible to identify break points | **Split documentation into separate pages whenever possible to identify break points | ||
**It is possible to name Wiki pages hierarchically, for example this page is '''Editing''', but its URL places it under the '''Help:Contents''' page, giving an option at the top of this page to move up hierarchy. | |||
*Within pages use short paragraphs or bullet points to aid readability | *Within pages use short paragraphs or bullet points to aid readability | ||
**Short sentences also aid readability, try to minimise use of "and", by either splitting sentence or expressing each clause as a numbered bullet point | **Short sentences also aid readability, try to minimise use of "and", by either splitting sentence or expressing each clause as a numbered bullet point | ||
| Line 16: | Line 17: | ||
**Only administrators can edit certain pages (like the "main page"), so linking to an existing category gives you link from "main page" | **Only administrators can edit certain pages (like the "main page"), so linking to an existing category gives you link from "main page" | ||
**You can of course create a new category page to which you will link multiple new pages, but it is best if that category page is in turn linked back to an existing category | **You can of course create a new category page to which you will link multiple new pages, but it is best if that category page is in turn linked back to an existing category | ||
** To add a link from your page giving your own text for somebody to follow to get to a category page, prefix that Category page name with a colon ("[[:Category: category_name|text_you_want]]". | ** To add a link from your page giving your own text for somebody to follow to get to a category page, prefix that Category page name with a colon <nowiki>("[[:Category: category_name|text_you_want]]"</nowiki>. | ||
=Creating a new page= | =Creating a new page= | ||
| Line 40: | Line 38: | ||
'''Be careful''' a reference to (for example) <nowiki>[[webTags]]</nowiki> would create a new page, as that capital '''T''' in the middle is different to the name of the existing '''Webtags''' page. | '''Be careful''' a reference to (for example) <nowiki>[[webTags]]</nowiki> would create a new page, as that capital '''T''' in the middle is different to the name of the existing '''Webtags''' page. | ||
==Templates== | |||
When you create a new page, you can reference templates that will add standard predetermined content to your page. | |||
* Type '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''' to add a banner to that point in the page saying "Work In Progress". The coloured background makes this content stand out. | |||
* Type '''<nowiki>{{Template:Version badge Mx}}</nowiki>''' to put your page into '''<nowiki>Category: Cumulus MX</nowiki>''' and display a MX symbol. | |||
* (For legacy cumulus) type '''<nowiki>{{Version badge 1}}</nowiki>''' to put the page into '''<nowiki>Category: Cumulus 1</nowiki>''' and display a "v1" symbol. | |||
Other templates are available, and you can create a new template if there is a standard piece of text you want to be able to insert in multiple places. | |||
==Renaming and Redirect== | ==Renaming and Redirect== | ||
| Line 50: | Line 58: | ||
If links to the old page exist, a standard logged-in user needs to manually edit each link individually. If redirect exists, the old links will get to the correct page by first opening the redirect page. If redirect does not exist, the old links will turn red, to indicate they now link to a non-existent page. A logged-in administrator can do a global edit, '''search for'' <nowiki>[[old-page-name</nowiki> and '''replace with''' <nowiki>[[new-page-name</nowiki>. | If links to the old page exist, a standard logged-in user needs to manually edit each link individually. If redirect exists, the old links will get to the correct page by first opening the redirect page. If redirect does not exist, the old links will turn red, to indicate they now link to a non-existent page. A logged-in administrator can do a global edit, '''search for'' <nowiki>[[old-page-name</nowiki> and '''replace with''' <nowiki>[[new-page-name</nowiki>. | ||
=Editing a page= | =Editing a page= | ||
| Line 139: | Line 146: | ||
===Creating Sections=== | ===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 has a table of contents | 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 has a table of contents (as with this page). | ||
If you split your page into sections, editing will be easier, as you can select to edit just one section (and any sub-sections), instead of using the '''Edit''' tab which shows the entire page in the editing window. | |||
*All you need do is mark your headings appropriately. | *All you need do is mark your headings appropriately. | ||
| Line 146: | Line 155: | ||
**Only those with administrative access can edit this page, so standard users do not see an "Edit" tab for this page | **Only those with administrative access can edit this page, so standard users do not see an "Edit" tab for this page | ||
*WikiText will then automatically create the sections, deal with all the formatting of headings, and make the page look good. | *WikiText will then automatically create the sections, deal with all the formatting of headings, and make the page look good. | ||
**If you create more than three sections, the Wiki will automatically generate a contents page | **If you create more than three sections, the Wiki will automatically generate a contents page ''just before your first heading.'' | ||
**If you want some text to be seen before the table of contents, don't use a heading before that text. | |||
To force creation of a table of contents on the right hand side of the page (so letting the reader see your introductory text before this) use <nowiki>{{TOCright}}</nowiki> as this page does. | To force creation of a table of contents on the right hand side of the page (so letting the reader see your introductory text before this) use <nowiki>{{TOCright}}</nowiki> as this page does. | ||
| Line 220: | Line 230: | ||
Examples: <nowiki>[[Webtags]]</nowiki> and <nowiki>[[Webtags|Cumulus web tags]]</nowiki> | Examples: <nowiki>[[Webtags]]</nowiki> and <nowiki>[[Webtags|Cumulus web tags]]</nowiki> | ||
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 <nowiki>[[webtags]]</nowiki> or <nowiki>[[Webtags]]</nowiki> is the same as Wiki will always uppercase the first letter. | :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 <nowiki>[[webtags]]</nowiki> or <nowiki>[[Webtags]]</nowiki> 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. | 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 == | ==Creating a link to an external page == | ||
| Line 232: | Line 241: | ||
The reader will see the word '''Google''' but on clicking that they will be taken to an external page. | The reader will see the word '''Google''' but on clicking that they will be taken to an external page. | ||
If you are happy for the URL to be seen, without descriptive text, then just type the URL. | |||
The chain links icon can be used to enter an external link as well as any internal one. | |||
==Using images== | ==Using images== | ||
| Line 237: | Line 250: | ||
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. | 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 [[Special:Upload|Upload file]] option in the toolbox in the navigation bar on the left. Once uploaded you may insert your image on your page using | To upload the image, use the [[Special:Upload|Upload file]] option in the toolbox in the navigation bar on the left. Once uploaded you may insert your image on your page using double square brackets, the word 'file:' and the filename. Example <nowiki>[[File:map.jpg]]</nowiki> | ||
