Handy's Quick Reference for Wiki page Creation - Editing

From Manjaro Linux
Jump to: navigation, search

A Rough Guide to Wiki page creation & editing:

This rough & tumble guide to creating a new page in the wiki, was created by an improviser. There are probably other ways to do it, but I don't know them & this works very well indeed for me.

For those new to wiki page creation/editing it is worth remembering that you really don't need to know much about wikicode to do all that you want to do. The more complex stuff of laying out tables & wiki page tables of contents & a pile of other things that I don't even know exist are just not at all necessary.


Creating a new topic/page:

First use the wiki page to create an account, so you can login & edit.

Once logged in you will see these [edit] links positioned in the top right hand corner of their editable sections. There is also an edit option up at the top of each wiki page, which loads the entire page into the wiki editor.

The simplest way to create a new wiki page is to hit the closest [edit] link, that is above the section that you want to place your topic in.

Then navigate down to where you want to place your new topic (it doesn't take a very long look to see how the separate topics are listed) & copy one of the ones in the same column (if there are columns), that is above or below you (when you are a beginner, it is easiest to do that in the same column that you want to put yours as it saves you having to deal with placement, though the Manjaro wiki has improved to the point where that shouldn't be a problem now, at least on the main page anyway).

Now that you have copied one choose where you want to place it, put your cursor there & hit it once or twice (you can tidy up the blank line spacing when you've finished) & paste in your duplicate. We'll get into a description (which you don't really need but its worth going through once) of just what the wiki code is doing next.


The wikicode that lists a page, making it accessible:

The following, may look quite complex at first view, but really, when you copy something like this that someone else has created, all you have to do is identify the parts that you have to change, which is really quite simple:

* '''[[Set DNS and-or Nameservers]] 
 <font style="font-weight: bold; color: green;">(NEW! 20-July-2013)</font>
 : ''Some users get their DNS or nameservers overwritten in resolv.conf on
 boot, using resolvconf.conf will prevent this ''.


* this places a bullet right before the page name. You can nest bullets like so ** .

  • This is an example of a bullet, there must be no space or other character to the left of the asterisk.

'''text sandwiched between three single quotes is made bold'''. This does not carry on to the next line on wiki pages. So when you are formatting your page content remember that you need to place '' for italic or ''' '' for bold italic at the beginning of new lines to continue using such format.

Lines that the wiki page displays on new lines (wraps) due to screen resolution/size & font size carry the formatting with them, so you don't have to worry about that. (There is more on wiki formatting to come.)

[[title of your page]] the text enclosed by these dual sets of square brackets is the name of your wiki page, which you MUST change as it creates your new page. This will show not only in this table of contents list but also as the title of your page. It is possible to change the displayed name by adding the following at the end of the current name:

| then adding the new name that you want to use directly after the pipe | symbol, like this:

[[Set DNS and-or Nameservers|Set Nameservers]] This will now display Set Nameservers as the table of contents & wiki page titles.

<small> </small> sets the enclosed text to a smaller size. You can format the enclosed text as has been done in our example with the use of:

''enclosed text'' which in our example, causes Handy to be displayed in italic format text.

The following long string says what it is doing. Just copy that in to the same location (if you have to) & change the date to suit your new addition to the wiki page (you will most likely never need to use these commands for anything else):

<font style="font-weight: bold; color: green;">(NEW! 20-July-2013)</font>

this starts a new, unformatted line.

'' '' we already know that text enclosed in these display as italic. This section of text is where we place our page description, trying to make it as clear & concise as possible.

. It is a convention on the Manjaro wiki to place the period outside of the formatted text.

So now you know what all the parts of the topic listing wikicode mean & you also know that you don't have to worry about most of it.


The Easy Steps for Creating a New Wiki Page:

  • Copy & paste a previously entered topic section (like our previous example), pasting it where you want your new page to be listed.
  • Rename the title on the first line between the [[ ]] brackets with your new page's topic name.
  • Replace the previous author's name with your own.
  • Change the date in the New!... section. OR copy & paste the following into the same place as in our example above (changing the date of course):
 <font style="font-weight: bold; color: green;">(NEW! 20-July-2013)</font>  
  • Add your clear & succinct description to the last line.
  • Then hit the Show Preview button at the bottom of the wiki editing page to check that it looks right. If it doesn't go back in & have a look for any typos. If you can't see any have another read of this section of this page in another browser tab.
  • When you have got it right, hit the Save Page button at the bottom of the wiki edit page.


That's it for creating a new page. This is probably the hardest part of the whole wiki experience. Beyond this it is pretty simple, there are just a few new things, some that you will want to use others you may never need to.

Once you have done the above, your page title will be listed where you placed it. You then click on your new link which will take you to a new blank page with the title that you gave it. Now all you have to do is add your content & use a few simple formatting tricks, most of which, like bold, italic, bold italic, you already know.


Wiki Formatting:

Headings - that also automatically create the table of contents:

Enclosing text in equals = = signs creates section headings that are automatically added to your pages table of contents at the top of your page. You don't have to do anything, this is built-in wiki stuff.

You must use the same number of equals signs on each side of your heading, the more equals signs you use (up to 6) the smaller your headings become & the more nested they show in the table of contents at the top of the page. It doesn't take long to learn how this works & due to the effect this can have on a well put together wiki page, it is one of the wiki page's biggest strengths.

Following are Examples of using the = signs on headings, check out the table of contents at the top of the page to see what's happening there too:

One equals sign:

= One equals sign =

Two equals signs:

== Two equals signs ==

Three equals signs:

=== Three equals signs ===

Four equals signs:

==== Four equals signs ====

Five equals signs:

===== Five equals signs =====

Six equals signs:

====== Six equals signs ======


Italic text '' '' :

Enclosing text between a set of two single quotation marks displays the enclosed text in italic format. The wikicode looks like this ''italic format''.

Italic text: '' ''

Note: You may be wondering how to show the following 
wikicode, like ''italic format'' 
(& the other previously shown wikicode). 

To do this you need to enclose any wikicode that you want 
to show in a wiki page for whatever reason between the 
following wikicode: 

<nowiki>   </nowiki> 

As usual it is easy once you know how.

Bold text ''' ''' :

Enclosing text between a set of three single quotation marks = bold like so '''three single quotation marks = bold'''.

Bold text: ''' '''

Bold-Italic text ''''' ''''' :

Enclosing text between a set of five single quotation marks = bold-italic like so '''''five single quotation marks = bold-italic'''''.

Bold-italic text: ''''' '''''

Adding pictures:

Pictures are no problem. I personally like to put them as thumbnails. So I will provide the basic syntax for that:

[[File:imagename.extention|thumb|left|375px]]

Text to go beside the picture

<br clear="all"/>

Here is a breakdown of the wikicode used to add a picture:

File: add your imagename.extension after 'File: this is pretty straight forward. Rather like creating an article link. You will then click the red link (once the wiki page has been saved) after you will be presented with a page where you can browse to your picture (usually on your own computer) & then upload the picture. It is a simple process.

|thumb tells the wiki it is a thumbnail, resulting in a nice border around the image.

|left tells the wiki that the image is to be aligned left. You can use "centre" or "right" instead, if you want.

|375px tells the wiki the size of the image to display in pixels. You can state anything suitable that you want - it will enlarge or minimise the image as you wish.

Text to go beside picture the meaning is obvious.

<br clear="all"/> you can write text to go beside the image. This command clears the left-alignment formatting. Leave it out to see what happens for a better understanding if you wish. (Other uses for this command follow.)

Handling [ ] square brackets & any other wikicode characters:

As previously mentioned, you can escape [ ] square brackets & other characters that are reserved for wikicode, by encasing such between the following commands:

<nowiki> </nowiki> :


"Support" section, please add this to the end of any wiki page that you create:

Unless it is not appropriate, add the following Support heading & put the URL of the associated Manjaro forum thread inside of [ ] square brackets.

Sometimes it may be appropriate to create a new thread for support &/or feedback on the topic that you have added to the wiki. More often it will be that the wiki page has come from a page in the Manjaro Tutorials sub-forum.

The [[Category:Contents Page]] wikicode placed at the bottom of the page, adds your page to the alphabetical table of contents page, so it needs to be there.

The following is using so you can see the URL inside of the square brackets. This same Support section is used at the bottom of this page:

=Support=

Following is a link to this page's forum counterpart where you
can post any related feedback: [https://forum.manjaro.org/index.php?topic=4808.0]

<br clear="all"/>
[[Category:Contents Page]]


My thanks to Quantum for pointing out the benefit of using the wikicode.


Editing the The Five Latest Changes list:

The most efficient way to add your new page to the top of the five latest changes section of the wiki's main page: [1] that I have come up with, is to edit the fifth, (which is the oldest & at the bottom of the five). Replacing its page name with your new page name & to also change the date appropriately.

Then cut that whole section section & paste it in at the top of the top five. Remove the blank line that gets added at the bottom of the list when you remove number five & make sure you haven't made any mistakes where you have pasted you new edited version in.

Check your modifications with the Show Preview button at the bottom of the wiki edit page to make sure that everything is how it should be, before hitting the Save Page button at the bottom of the wiki edit page.

Here is what that section currently looks like which may be useful if you make a mistake & don't know how to fix it:

= What's New - The Five Latest Changes =

[[File:New-Logo.png|left|96px]]

{|
|[[Octopi|Octopi: GUI for package management]]
|style="text-align:right"|<font color="green">26th July 2013</font>
|-
|[[Patch wireless drivers with Compat-Drivers]]
|style="text-align:right"|<font color="green">25th July 2013</font>
|-
|[[Set DNS and-or Nameservers]]
|style="text-align:right"|<font color="green">20th July 2013</font>
|-
|[[DNS Cache Poisoning, How to Prevent It, and Encrypt Your DNS Requests]]
|style="text-align:right"|<font color="green">16th July 2013</font>
|-
|[[Orphan Package Removal]]
|style="text-align:right"|<font color="green">Updated 16 July 2013</font>
|-


<div style="clear: both"></div>
|}
<br clear="all" />


On the interaction between a forum Tutorial & its wiki page

I've found it to be a good idea to replace the OP of a Tutorial in the forum, that I wikify, with a brief instruction that points to a link to the wiki page. As it saves having to maintain two documents when one (the wiki is always easier to use/navigate & is often more comprehensive) will do.

Also, when there are any updates in the wiki page, I'll announce it in the associated thread, also, making a note that starts with a date in the OP as well, just for good measure.

If I think the wiki update is substantial enough, I'll add it to the top of the Five Latest Changes, on the wiki main page & also add an Updated <date> to its title link (same as the NEW! <date> routine) on the main page.


Attitude & Wiki Content:

I'll add that when making a wiki page, we have to be careful to not get too personal, to be somewhat objective about whatever the subject. A program or tool that you think has no competition, is still a subjective view.

There are always plenty of others out there that don't agree with you at all, & can put up a strong argument as to why.

So point out the good & bad, the things to be careful of, how to make it easier to install, to configure, to use, to aid compatibility & so on.

Something else I'll add is that when you give your knowledge & experience to others (in any way) it shouldn't come with a proviso that says if you stop behaving the way I want you to, I'm going to take back my help. Meaning, if you choose to leave Manjaro (or any other distro) because you don't like it (for whatever reason), any more. You don't go in & delete all your posts, tutorials & wiki pages. You just move on & leave your legacy.

Reference:

Some wiki editing references follow:

https://en.wikipedia.org/wiki/Wikipedia:Cheatsheet

https://en.wikipedia.org/wiki/Help:Wiki_markup

https://en.wikipedia.org/wiki/Help:Contents/Browse/Site_map


Support:

Following is a link to this page's forum counterpart where you can post any related feedback: [2]