Editing Tips: Difference between revisions

(4 intermediate revisions by one other user not shown)

Line 1:

Editing a page in a wiki is quite easy - just click on the "edit" tab at the top.

For the CCMDB wiki, you need to be [[Logging on to the wiki|logged]] on to edit. If you are involved with the CCMDB, contact [[Tina Tenbergen]] to have an account created.

For the CCMDB wiki, you need to be [[Logging on to the wiki|logged]] on to edit. If you are involved with the CCMDB, contact [[p:Tina Tenbergen]] to have an account created.

~~:'''''NOTE: When editing text, please make sure that you are editing the most recent version of the page and not a previous version otherwise interim edits will be lost~~! The ~~most recent version~~ of a ~~page will have no revision information below the title unlike earlier versions~~. ~~This is~~ a ~~quick visual clue to help guide you during the editing process. Also~~, ~~if you end up~~ on the edit ~~page, there is~~ a ~~bold warning at~~ the top of the ~~edit box~~, e.g.,

== Be bold! ==

The main idea of a wiki is that any of us can add, update and improve it. If you see a typo, a run-on sentence or something that is not stated clearly, '''edit it''' by clicking the edit tab a the top. Make the changes, don't be too concerned that you may have misunderstood or step on someone's toes. The wiki keeps track of all changes, and if something goes really wrong, you can revert any entry to an earlier version using the "history" tab.

~~::'''Warning: You are editing an out-of~~-~~date revision of~~ this ~~page~~.~~''' If~~ you ~~save~~ it, ~~any changes made since this revision will be lost~~.

When you write anything for this wiki, keep it short and concise - this is for information, not entertainment. When you find an entry getting much longer than what fits onto one screen, consider if it can be split into sub-entries. There is no hard rule there, just think of usability as a reference. Often point form (i.e. starting lines with a *) is is more suitable than full sentences.

:'''''~~Please keep these editing gotchas in mind.~~'''''

=== Watch those versions! ===

When editing text, please make sure that you are '''editing the ''most recent version'' of the page''' and not a previous version otherwise interim edits will be lost! The most recent version of a page will have no revision information below the title unlike earlier versions. This is a quick visual clue to help guide you during the editing process. Also, if you end up on the edit page, there is a bold warning at the top of the edit box, e.g.,

~~== Be bold! ==~~

:: '''Warning: You are editing an out-of-date revision of this page.'''

~~The main idea~~ of ~~a wiki is that any~~ of ~~us can add, update and improve it~~. ~~If you see a typo, a run-on sentence or something that is not stated clearly, '~~''~~edit it~~''' by clicking the edit tab a the top. Make the changes, don't be too concerned that you may have misunderstood or step on someone's toes. The wiki keeps track of all changes, and if something goes really wrong, you can revert any entry to an earlier version using the "history" tab.

~~When~~ you ~~write anything for this wiki~~, ~~keep it short and concise -~~ this ~~is for information, not entertainment. When you find an entry getting much longer than what fits onto one screen, consider if it can~~ be ~~split into sub-entries. There is no hard rule there, just think of usability as a reference. Often point form (i.e. starting lines with a *) is is more suitable than full sentences~~.

If you save it, any changes made since this revision will be lost.

==Wiki mark-up==

==Wiki mark-up - [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia's Cheatsheet]==

Wikis use what is called a "mark-up" to show that something is a heading or a list item. If you are not sure how to do something in wiki mark-up, click on the "edit" tab of an entry that is set up the way you are trying to do.

Line 57:

Line 58:

If the category you use does not exist yet, the wiki will create it and group all further entries with the same category on that category's page. Check the [[:Special:Categories]] page before you create a new category to make sure a similar one does not already exist.

~~===Stubs===~~

~~One special category of entries is a '''stub'''. If you know enough information to start an entry, but know more is needed to make it useful, add it to the [[:Category:Stubs]] category.~~

== Tables in the wiki ==

The wiki markup for tables is somewhat complicated to set up manually. There is an excel sheet that converts a table to wiki markup automatically. You can download it [[:image:Wiki_Tables.xls|here]].

[[Category:Wiki ~~Usage~~]]

[[Category:Wiki use]]

@@ Line 1: / Line 1: @@
 Editing a page in a wiki is quite easy - just click on the "edit" tab at the top.
-For the CCMDB wiki, you need to be [[Logging on to the wiki|logged]] on to edit. If you are involved with the CCMDB, contact [[Tina Tenbergen]] to have an account created.
+For the CCMDB wiki, you need to be [[Logging on to the wiki|logged]] on to edit. If you are involved with the CCMDB, contact [[p:Tina Tenbergen]] to have an account created.
-:'''''NOTE: When editing text, please make sure that you are editing the most recent version of the page and not a previous version otherwise interim edits will be lost! The most recent version of a page will have no revision information below the title unlike earlier versions. This is a quick visual clue to help guide you during the editing process. Also, if you end up on the edit page, there is a bold warning at the top of the edit box, e.g.,
+== Be bold! ==
+The main idea of a wiki is that any of us can add, update and improve it. If you see a typo, a run-on sentence or something that is not stated clearly, '''edit it''' by clicking the edit tab a the top.  Make the changes, don't be too concerned that you may have misunderstood or step on someone's toes. The wiki keeps track of all changes, and if something goes really wrong, you can revert any entry to an earlier version using the "history" tab.
-::'''Warning: You are editing an out-of-date revision of this page.''' If you save it, any changes made since this revision will be lost.
+When you write anything for this wiki, keep it short and concise - this is for information, not entertainment. When you find an entry getting much longer than what fits onto one screen, consider if it can be split into sub-entries. There is no hard rule there, just think of usability as a reference. Often point form (i.e. starting lines with a *) is is more suitable than full sentences.
-:'''''Please keep these editing gotchas in mind.'''''
+=== Watch those versions! ===
+When editing text, please make sure that you are '''editing the ''most recent version'' of the page''' and not a previous version otherwise interim edits will be lost! The most recent version of a page will have no revision information below the title unlike earlier versions. This is a quick visual clue to help guide you during the editing process. Also, if you end up on the edit page, there is a bold warning at the top of the edit box, e.g.,
-== Be bold! ==
+:: '''Warning: You are editing an out-of-date revision of this page.'''
-The main idea of a wiki is that any of us can add, update and improve it. If you see a typo, a run-on sentence or something that is not stated clearly, '''edit it''' by clicking the edit tab a the top.  Make the changes, don't be too concerned that you may have misunderstood or step on someone's toes. The wiki keeps track of all changes, and if something goes really wrong, you can revert any entry to an earlier version using the "history" tab.
-When you write anything for this wiki, keep it short and concise - this is for information, not entertainment. When you find an entry getting much longer than what fits onto one screen, consider if it can be split into sub-entries. There is no hard rule there, just think of usability as a reference. Often point form (i.e. starting lines with a *) is is more suitable than full sentences.
+If you save it, any changes made since this revision will be lost.
-==Wiki mark-up==
+==Wiki mark-up - [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia's Cheatsheet]==
 Wikis use what is called a "mark-up" to show that something is a heading or a list item. If you are not sure how to do something in wiki mark-up, click on the "edit" tab of an entry that is set up the way you are trying to do.
@@ Line 57: / Line 58: @@
 If the category you use does not exist yet, the wiki will create it and group all further entries with the same category on that category's page. Check the [[:Special:Categories]] page before you create a new category to make sure a similar one does not already exist.
-===Stubs===
-One special category of entries is a '''stub'''. If you know enough information to start an entry, but know more is needed to make it useful, add it to the [[:Category:Stubs]] category.
 == Tables in the wiki ==
 The wiki markup for tables is somewhat complicated to set up manually. There is an excel sheet that converts a table to wiki markup automatically. You can download it [[:image:Wiki_Tables.xls|here]].
-[[Category:Wiki Usage]]
+[[Category:Wiki use]]