Help:Editing

From MobileRead
Jump to: navigation, search

Basic wiki markup is so easy that you have no excuse not to use it. It's pretty similar to what you use in text-only email. A tool bar is provided at the top to help with the editing.

Contents

Advertisement

[edit] Paragraph formatting

 like this

[edit] Links

Hover text is the text that shows up when you place the cursor over a linked word. Normally it will the the link name but you can make it any text you wish with syntax that looks like the example below taken from the home page:

[[Mobile devices|<span title="Handheld devices that can display eBooks among other functions">Mobile Devices</span>]]

[edit] Redirect

It is a good idea to redirect alternate spellings and abbreviations that people are likely to use. Build a page with the alternate name to point to the original name containing the data. It should contain one line on it like this:

#REDIRECT [[Original name]]

Redirects can also zero in on a topic within a page so long as it has a heading. The syntax is similar to a jump within a page in html. It should contain one line like this:

#REDIRECT [[Page name#heading name]]

A category can also be added to a redirect page. Use this when an alternate name is being redirected that users are likely to use and they are unlikely to realize that the real name is the one they want. Don't use category for spelling changes.

Normally redirects are transparent. They will be indicated just under the title on the page after the redirect completes. Tapping this link will bring up the redirect itself which is useful if you need to edit it.

[edit] Lists

  1. Use # characters for numbered lists.
    1. Go deeper with more #'s or *'s

[edit] Sections

The contents box appears if there are more than 3 sections on a page. Placing __TOC__ in the text will force the contents box. It will appear at the location specified.

[edit] Images

Here is an example Image format taken from the hardware template format.

[[Image:reader1.jpg|thumb|right|320px|Dan Brown's ''Da Vinci Code'' on the Sony Reader.]]

The word Image or File can be used to specify images.

Only the original entry is required. The options are separated with a | and mean:

If the image does not exist it will be replaced with a box with text in it. Tapping the text will direct you to a page where you can upload the image. This is the best way to include an image as the name will automatically be renamed if needed to match the image on the target page.

[edit] Media link

In addition to images you can have links to other media items for the reader to choose. Tap the media link above the editing box to produce: [[Media:Example.ogg]]. Change the text to what you need. This is a great way to provide downloads within the wiki.

[edit] Category

Collecting pages into categories makes it easier to find related items.

[[category:Help]]

Multiple lines may be used. Always place at the bottom of the file.

[edit] Tables

Tables may be included using a special wiki format or standard html format. An introduction to the wiki format is included here. For more information on tables see Advanced Table Editing

An easy way to make a table is to build a spreadsheet and then paste the contents into this wiki page.

[edit] Ignore wiki formatting

To ignore wiki formating place <nowiki> and </nowiki> around the text. This can also be achieved by tapping the no wiki icon just above the editing box.

[edit] Footnotes

This wiki now supports footnotes. The syntax and tags are <ref[ name=id]> and <references/>. The data inside the [] is optional (Don't enter the brackets) and used to provide a name which can be referenced. These may be used for explanations or citations. The <ref> tag needs a closing </ref> tag with the reference data in between. If a reference is named it can be used additional times without reentering the data.

The <references/> tag is required and should be placed at the point where you want all the information to be displayed (usually a section titled references or footnotes. Both forward and back links will be built automatically. For more information see: Cite extension

[edit] Styles for text

To show colored text: <span style="color:red">red</span>
To center some text: {{center|text to be centered}}

[edit] Syntax Highlighting

This wiki nows supports syntax highlighting. See SyntaxHighlight GeShi for more details. Adding syntax tags is like the pre tag in that the font will be changed to courier (fixed width) and lines will not be wrapped. To add syntax you should enter <syntaxhighlight lang="xxx"> and end with </syntaxhighlight> The lang should be set to one of the many choices outlined on the details page. For MobileRead use these are likely to be:

There are other options as well. line start="xx" would add line numbers beginning with xx. Adding highlight="yy" would darken line number yy. the option enclose="div" would allow the line to wrap.

Personal tools
Namespaces
Variants
Actions
Navigation
MobileRead Networks
Toolbox