Help:Editing

From ownCloud.org

If you need help with syntax that is not listed here, the Mediawiki Help should contain it. There is also a handy reference card image.

Basic Syntax

'''bold text'''

''italics''

'''''bold italics'''''

<code>Monospace text</code>

Lists

* A list item
* Another list item
** Oh joy, more list items!

# A numbered item
# Another numbered item
## Sub items
## More sub items
# Third numbered item

* An unordered item...
*# With a sub-list that is ordered
*# More steps
* Back to the first list
*# Another ordered list
*#* With its own sub point

Links

Visit [[Installation]] to learn more about
ownCloud installation.

Our [[Features|features page]] tells about features currently present and features that will be implemented in future.

[[The weather in London]] is a
page that doesn't exist yet.

http://owncloud.org/

Here are some sites:
[http://www.deviantart.com]
[http://www.flickr.com]

[http://owncloud.org Our home page]
is full of interesting information.

Use a ':' in the link to link
to an [[:Image:Growth_wide.jpg|image]].

The [[:Category:Documentation]] lists all 
end-user documentation.

The [[Category:Documentation]] link puts
this page in the listed category; the link
appears automatically on the bottom of the
page and not inline.

Tables

Tables should be used sparingly and only when necessary.

For more advanced table usage, read up on Mediawiki.org's page on tables.

{|

! Column 1 !! Column 2 !! Column 3

|-

| Cell 1 || Cell 2 || Cell 3

|}

IRC Logs

IRC logs can either be surrounded in <pre> tags, or converted into MediaWiki pipe-tables with irclog2html and Ian's MediaWiki patch for irclog2html.

Writing Example Commands

Example commands are one or more commands set apart from the body of the explanation. Do not use prompt symbols or any other content that shows machine name, user, directory, etc. (which are details set in the $PS1 environment variable.)

Enclose any example command in <pre></pre> tags:

<pre>
su -c "yum install awesome-application"
</pre>

Enter the <code>root</code> password when prompted.

Which produces:

su -c "yum install awesome-application"

Enter the root password when prompted.

If the command requires elements to be quoted, nesting should be " ' ' ", with the single quote marks surrounded by one containing set of double quote marks. For example:

su -c "command -o 'Some Text' -file 'More text' foo/bar"

If you need to have a series of commands or su -c is not responding as expected, have the user switch to root and warn the user to return to a normal user shell afterward.

su -
Password:
service food stop
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
vi /etc/foo.d/foo.conf
food --test-config
...
service food start
exit

Example command output

When the example shows a command as part of showing the output to the screen, you may use a command prompt to clarify commands and output.

$ su -c "ls -l /root"
Password: 
total 148
-rw------- 1 root root  1961 2007-09-21 02:46 anaconda-ks.cfg
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
-rw-r--r-- 1 root root  6079 2007-09-21 02:42 install.log.syslog
-rw-r--r-- 1 root root  3699 2008-07-28 17:24 scsrun.log
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
-rw-r--r-- 1 root root  1317 2008-01-10 10:20 upgrade.log.syslog

Structure of a Wiki Page

This section describes the common structure of a wiki page.

• The title of the page is a first-level header. It is created automatically from the page title.
• Sections are created using the equals symbols in pairs:

  == Header 2 ==
  === Header 3 ===
  ==== Header 4 ====
  ===== Don't do this, 5 levels of nesting means you need a new page or three =====
  

• The table of contents is automatically created and populated when the page grows big enough.
• Anchors to sections are automatically created, with specific symbols used in place of punctuation and spaces:

  This page ==> This_page
  This, that, and the other page ==> This%2C_that%2C_and_the_other_page
  

Learn by Example

Among the better ways to learn how to edit the wiki is reviewing the code of existing pages. This is very easy to do:

1. Find a page whose source you would like to view.
2. Click on either the edit or view source tab at the top of the page.

The wiki will display the plaintext form of that page. This is particularly valuable for learning some of the clever tricks used by wiki editors ahead of you. Those 'clever tricks' are valuable, as they allow you to do unique, interesting, and powerful things you might not have thought were possible. You might try this on pages like Main Page (but please don't make drastic or unwanted edits to this page!).

Marking Technical Terms

Use the code markup (<code></code>) to mark the names of applications, files, directories, software packages, user accounts, and other words that have a specific technical meaning. This displays the marked words as monospace.

Use two single-quotes (''[name of menu]'') to mark the names of menu items and other elements of the graphical interface. This displays the marked words in italic.

 '''boldface''' 

 <code>inline code tags</code> 

 <code>package name</code> 

 <code>username</code> 

 <code>technical term</code> 

 ''Menu name'' 

 ''two single-ticks'' 

 <code>command -option</code> <code>daemon</code>

 <pre>whitespace preserved< /pre> 

whitespace

   is preservered
 here

 <code>inline whitespace not preserved</code> 

 ''term'' 

 '''[Key]''' 

For example:

The <code>thunderbird</code> package installs the '''Mozilla Thunderbird'''
e-mail application. To start '''Thunderbird''', select:
  ''Applications > Internet > Thunderbird Email''.

Which produces:

The thunderbird package installs the Mozilla Thunderbird e-mail application. To start Thunderbird, select: Applications > Internet > Thunderbird Email.