Difference between revisions of "Help:Formatting"
(Imported from old formatting article) |
m (cat) |
||
| Line 285: | Line 285: | ||
{{Help}} | {{Help}} | ||
| − | [[Category:Help| | + | [[Category:Help|Formatting]] |
Revision as of 00:04, 21 April 2010
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.
Contents
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.
You must input the full link, including http://, or the link will not work
| 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 |
|
| Simple numbered list uses the pound sign |
#First do this #Then do this ##Consider this ##Consider this as well #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 |
|
Simple Bulleted Lists
Use these when you just need to list things and don't need to provide (hardly) any additional information about them -- names only
| For example, great in listing proper names that need little no additional explanation | |
The city of Shima was formerly five separate entities: *Ago (阿児町) *Isobe (磯部町) *Shima (志摩町) *Hamajima (浜島町) *Daiō (大王町) |
The city of Shima was formerly five separate entities:
|
Simple Numbered Lists
Use these when you explicitly need to give a sequence to the order.
| For example, numbered lists are ideal when giving directions for accomplishing a specific task | |
How to make a [[Bank Transfer|furikomi]]: #Select furikomi (振込) from the menu #Put your bank card and PIN number in #Put in the bank and branch name you are sending money to #...some other stuff... #All done |
How to make a furikomi:
|
Title + Description Lists
This is the primary type of list you find around the Mie Guidebook. It is extremely useful because it allows you to specify a name, a few critical notes on the line, and then give a detailed description underneath. This format is especially easy to read and makes long lists of data more readable...and better.
Articles contain a simple * to start the list. The first thing after the * is the bolded title, and if there are any notes or map links they should follow the title. On the second line the description must start with *:. It is best to leave the *: even if there is no description. If you want a link break in your description, make sure the second line (still under the original title) also begins with *:.
| These are all around the guidebook, especially the location articles. Refer to them for more examples. | |
*'''MaxValu''' - Open 9:00 ~ midnight, 7 days a week
*:Found in central Odai, right next to the Town Office.
*'''Miyagawa Bakery'''
*:
*'''Convenience Stores''' (''kombini'')
*:Two Circle K shops and a Family Mart.
*:Almost all of them can be found along Route 42.
*'''Michi-no-eki Ōdai''' (道の駅 大台) - Open 8:00 ~ 7:00pm
*:Acts as a stall for local farmers to sell their produce.
|
|
| These are all around the guidebook, especially the location articles. Refer to them for more examples. | |
*'''Gyoza King''' (餃子の王将 ''gyōza no ōshō'') *:Best gyoza you can find at a chain; true to its name. *'''Denny's''' *:Tasty, but ''not'' at all like Denny's in the US. *'''Yoshinoya''' (One on 54, one on 23) *: *'''McDonald's''' (There are at least five in town) *: *'''Sushi Roll''' (スシロー) - At [[Loc Town]] *:Taste-wise the best conveyor-belt sushi in town. *:059-375-1770 *'''Kura-zushi''' (くら寿司) *:Ultra-automated conveyor-belt - tastes good *'''Kappa-zushi''' *:Worst conveyor-belt sushi your ¥105 can buy. |
|
| Help | |
|---|---|
| Guidebook Help | Guidebook Usage • Basic Editing • Formatting and Markup • Manual of Style • Do's and Don'ts • Uploading Images |
