Help:Editing

From Mie Guidebook
Revision as of 21:12, 19 April 2010 by Jpcase (Talk | contribs) (Add list cheat sheet)

Jump to: navigation, search

Browse to the section you are looking for.

Each section starts with a short formatting "cheat sheet", and is then followed by a more detailed description of how and when to use each type of formatting.

Bold and Italic

Bold and italic, unlike HTML, are indicated with the quote marker. Two quotes for italic, three for bold.

Description You type You get
Bold
'''example'''
example
Italic
''example''
example
Bold + Italic
'''''example'''''
example

Links

Easily creating links is one of the main benefits of using a wiki and it is a feature that should be taken advantage of liberally.

Description You type You get
Internal link
must be exact article title
[[Mie Prefecture]]
Mie Prefecture
Internal link
with alternate text

very useful, allows more freedom
[[Mie Prefecture|Mie-ken]]
Mie-ken
External link
must include http://
[http://www.miejets.org/forum]
[1]
External link
with alternate text

note the space
[http://www.miejets.org/forum Mie JETs Forum]
Mie JETs Forum

Internal Links

Internal links, or wikilinks, are links to other pages within the guidebook. These are the heart of the guidebook and allow for navigation of the many pages contained within the wiki.

Internal links are made simply by placing the text inside double brackets like [[...]]

A good example of an internal link is when you are writing a city/town article and want to link to special information about something you've listed - say a shopping center or festival.
Suzuka is home to the [[Bell City]] shopping center.
Suzuka is home to the Bell City shopping center.


Or even more simply, just linking to the city/town/other article names whenever you get the chance.
'''Meiwa''' is a town located between [[Matsusaka]] and [[Ise]].
Meiwa is a town located between Matsusaka and Ise.
'''MaxValu''' is a supermarket chain owned by [[AEON]].
MaxValu is a supermarket chain owned by AEON.


The alternative text ability, activated with the "pipe" character, can be a life-saver when editing text and stringing together prose.
Kumano is home to Mie's best [[Kumano Fireworks|fireworks show]].
Kumano is home to Mie's best fireworks show.
There is a [[109 Cinemas Yokkaichi|movie theater]] in the neighboring town of [[Yokkaichi]].
There is a movie theater in the neighboring town of Yokkaichi.
[[Getting a Driver's License|Getting your license]] in Japan isn't as easy as it should be.
Getting your license in Japan isn't as easy as it should be.
Many ALTs meet with their school's [[English Club Activities|English clubs]] once a week.
Many ALTs meet with their school's English clubs once a week.

External Links

External links are links to any internet site or page that is not part of the Mie Guidebook. In general these are used far less than internal links however they have their very necessary uses.

External links are made simply by placing the text inside single brackets like [...]. As internet URL's have no spaces, if you add a space after the URL, anything put after that space becomes the link's label text.

External links are great for adding extra info to an item or at the end of a page
'''109 Cinemas Meiwa''' - [http://www.109cinemas.net/meiwa/access.html map]
109 Cinemas Meiwa - map
'''The Melting Pot''' - [http://www.partyjapan.com Official site]
The Melting Pot - Official site

Lists

Formatted lists are one of the main keys to making the large amount of text contained in guidebook articles readable. Please use them as much as you can for anything that doesn't require prose.

Description You type You get
Simple bulleted list
uses the asterisk
*Item 1
*Item 2
**Item 2.1
**Item 2.2
*Item 3
  • Item 1
  • Item 2
    • Item 2.1
    • Item 2.2
  • Item 3
Simple numbered list
uses the pound sign
#First do this
#Then do this
##Consider this
##Consider this as well
#After that do this...
  1. First do this
  2. Then do this
    1. Consider this
    2. Consider this as well
  3. After that do this...
Title + description list
standard list format on this wiki
*'''Item 1'''
*:Description 1
*'''Item 2''' - Note
*:Description 2
*'''Item 3'''
*:Description 3
*:*Sublist item A
*:*Sublist item B
*'''Item 4'''
*:Description 4
  • Item 1
    Description 1
  • Item 2 - Note
    Description 2
  • Item 3
    Description 3
    • Sublist item A
    • Sublist item B
  • Item 4
    Description 4