Help:Formatting

From Gospel Translations

(Difference between revisions)
Jump to:navigation, search
(→Creating Links)
Line 1: Line 1:
-
__TOC__
+
{{PD Help Page}}
 +
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two single quotes like <tt><nowiki>''this''</nowiki></tt>
-
== Objectives ==
+
== Text formatting markup ==
-
There are two objectives to keep in mind when making formatting decisions:
+
-
# Making the text readable and attractive
+
-
# Conforming to the look-and-feel of the original text
+
-
If you're ever unsure of how to format a page, check out the work already done by others by browsing the library, ask questions of other editors, and then just try something. If someone wants to improve on it, they will!
+
{| align="center" {{Prettytable}}
 +
|-
 +
|{{Hl2}} |'''Description'''
 +
|{{Hl2}} |'''You type'''
 +
|{{Hl2}} |'''You get'''
 +
|-
 +
| colspan="3" align="center" | ''applies anywhere''
 +
|-
 +
|Italic text
 +
|<tt><nowiki>''italic''</nowiki></tt>
 +
|''italic''
 +
|-
 +
| Bold text
 +
|<tt><nowiki>'''bold'''</nowiki></tt>
 +
|'''bold'''
 +
|-
 +
| Bold and italic
 +
|<tt><nowiki>'''''bold & italic'''''</nowiki></tt>
 +
|'''''bold & italic'''''
 +
|-
 +
|Escape wiki markup
 +
|<tt><nowiki><nowiki>no "markup"</nowiki></nowiki></tt>
 +
|<nowiki>no ''markup''</nowiki>
 +
|-
 +
|Fixed width text
 +
|
 +
<nowiki><tt>Fixed width text</tt></nowiki>
 +
|
 +
<tt>Fixed width text</tt>
 +
|-
 +
| colspan="3" align="center" | ''only at the beginning of the line''
 +
|-
 +
| Indent text
 +
|
 +
<tt><nowiki>:Single indent</nowiki></tt><br />
 +
<tt><nowiki>::Double indent</nowiki></tt><br />
 +
<tt><nowiki>:::::Multiple indent</nowiki></tt>
 +
|
 +
:Single indent
 +
::Double indent
 +
:::::Multiple indent
 +
|-
 +
|Headings of<br />
 +
different levels <ref>An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].</ref>
 +
|
 +
<tt><nowiki>=level 1=</nowiki></tt><ref>Use of a level 1 heading is '''''highly discouraged''''' as it appears with the same formatting and size as the page title, which can be confusing.</ref><br />
 +
<tt><nowiki>==level 2==</nowiki></tt><br />
 +
<tt><nowiki>===level 3===</nowiki></tt><br />
 +
<tt><nowiki>====level 4====</nowiki></tt><br />
 +
<tt><nowiki>=====level 5=====</nowiki></tt><br />
 +
<tt><nowiki>======level 6======</nowiki></tt>
 +
|
 +
<!-- little hack to prevent TOC viewing -->
 +
<span style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</span><br/><br/>
 +
<span style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</span><br/><br/>
 +
<span style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</span><br/>
 +
<span style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</span><br/>
 +
{{DEFAULTSORT:[[[http://www.example.com link title]]#Redirect [[—[[Category:]]]]]}}<span style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</span><br/>
 +
<span style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</span><br/>
 +
|-
 +
|Horizontal rule
 +
|
 +
<tt><nowiki>----</nowiki></tt>
 +
|
 +
----
 +
|-
 +
|Bullet list
 +
|
 +
&#42; one<br />
 +
&#42; two<br />
 +
&#42; three<br />
 +
&#42;&#42; three point one<br />
 +
&#42;&#42; three point two<br />
 +
|
 +
* one
 +
* two
 +
* three
 +
** three point one
 +
** three point two
 +
|-
 +
|Numbered list
 +
|
 +
&#35; one<br />
 +
&#35; two<nowiki><br /></nowiki>spanning several lines<nowiki><br /></nowiki>without breaking the numbering<br />
 +
&#35; three<br />
 +
&#35;&#35; three point one<br />
 +
&#35;&#35; three point two<br />
 +
|
 +
# one
 +
# two<br>spanning several lines<br>without breaking the numbering
 +
# three
 +
## three point one
 +
## three point two
 +
|-
 +
| Mixture of bulleted<br /> and numbered lists
 +
|
 +
&#35; one<br />
 +
&#35; two<br />
 +
&#35;&#42; two point one<br />
 +
&#35;&#42; two point two<br />
 +
|
 +
# one
 +
# two
 +
#* two point one
 +
#* two point two
 +
|-
 +
|Definition list
 +
|
 +
&#59;Definition<br />
 +
&#58;item 1<br />
 +
&#58;item 2<br />
 +
|
 +
;Definition
 +
:item 1
 +
:item 2
 +
|-
 +
|Preformatted text
 +
|
 +
&nbsp;&nbsp;preformatted text is done with<br />
 +
&nbsp;&nbsp;a space at the<br />
 +
&nbsp;&nbsp;beginning of the line<br />
 +
|
 +
preformatted text is done with
 +
a space at the
 +
beginning of the line
 +
|-
 +
|Preformatted text with no indentation
 +
|
 +
&nbsp;<nowiki><pre> some preformatted text with no indentation </pre></nowiki>
 +
|
 +
<pre>
 +
some preformatted
 +
text with no indentation
 +
</pre>
 +
|-
 +
|Blockquotes
 +
|
 +
Body<br>
 +
text text text text text text text text text text text text
 +
text text text text text text text text text text text text
 +
<nowiki><blockquote>  quote quote quote quote quote quote </blockquote></nowiki>
-
== Templates ==
+
text text text text text text text text text text text text
-
To help you with formatting, we have already developed several templates that take care of basic functions:
+
|
-
* [[Template:LeftInsert|LeftInsert]] to place call-out boxes on the left
+
Body<br>
-
* [[Template:RightInsert|RightInsert]] to place call-out boxes on the right
+
text text text text text text text text text text text text
-
* [[Template:InfoBar|InfoBar]] to provide basic information about a resource on the top of each page
+
text text text text text text text text text text text text
-
We recommend that you begin by reading the [http://www.mediawiki.org/wiki/Help:Templates tutorial] on templates hosted at http://www.MediaWiki.org. That will give you a basic understanding of how templates work and you will be able to make your own for the whole community to use. For more immediate help, here is the code that you would insert in a page to use these templates.
+
<blockquote>  quote quote quote quote quote quote </blockquote>
-
To put text on the right or left in a call-out box, use:
+
text text text text text text text text text text text text
-
<nowiki>{{RightInsert|This text will appear on the right in a gray box}}
+
-
{{LeftInsert|This text will appear on the left in a gray box}}</nowiki>
+
-
{{RightInsert|This is lined up with the start of the paragraph at left.}} You will want to insert those codes at ''the beginning of the line'' on which you want the box to start. They are preformatted to only take up 20% of the available width of the page, so you don't need to worry about them getting to large. Just place the code immediately before the content that it should be lined up with, and it will automatically take up the right size and shape. So for example, in order to get the box at right to line up as it did, the source of this page reads:
+
|-
 +
|Comment
 +
|
 +
<tt><nowiki><!--This is comment--></nowiki></tt>
 +
|
 +
<!--This is comment-->|}
-
<nowiki>{{RighttInsert|This is lined up with the start of the paragraph at left.}} You will
 
-
want to insert those codes at...</nowiki>
 
-
You may notice that the call-out box appears to actually be a few pixels lower than the line of text to its left. This is because of automatic spacing around it to keep it from running into any text above, adjacent to, or beneath it.
+
Notes: <references/>
-
To insert the information bar, use:
+
== Paragraphs ==
-
<nowiki>{{InfoBar
+
-
|author=The name of the author or authors
+
-
|editor=The name of the editor or editors
+
-
|partner=The ministry or publisher that lent this resource to our library
+
-
|partnerurl=The web address for the ministry or publisher's homepage, beginning with http://
+
-
|other=Any additional info about the text, i.e., "This article originally appeared in
+
-
XYZ Magazine." Leave blank if desired.
+
-
}}</nowiki>
+
-
For an example of how that looks, look at an [[:How Not to Commit Idolatry in Giving Thanks|article]] and you will get the idea.
+
MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <tt><nowiki><br> or <br/></nowiki></tt>.
 +
== HTML ==
-
== Making References ==
+
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <tt><nowiki><code></nowiki></tt>, <tt><nowiki><div></nowiki></tt>, <tt><nowiki><span></nowiki></tt> and <tt><nowiki><font></nowiki></tt>.
-
Very often authors will cite others, and the software we use to run this site makes handling those easy. The system only requires that you place the actual reference within <nowiki><ref> and  </ref> tags, and that you include the code </nowiki>
+
-
== References == <references />
+
-
at the bottom of the article, chapter, or other text you are translating. So for example, if your text includes the lines,
+
{{Admin tip|tip=If you trust your users you can allow full HTML by setting <code>{{mediawiki|Manual:$wgRawHtml|$wgRawHtml}} = true;</code> in {{mediawiki|Manual:LocalSettings.php|LocalSettings.php}}.}}
-
"Then must you speak
 
-
Of One that lov'd not wisely but too well."<sup>2</sup>
 
-
and footnote 2 is marked
+
== Other formatting ==
 +
Beyond the text formatting markup shown above, here are some other formatting references:
 +
*[[Help:Links|Links]]
 +
*[[Help:Images|Images]]
 +
*[[Help:Tables|Tables]]
 +
*[http://en.wikipedia.org/wiki/Wikipedia:WikiProject_User_Page_Help/Do-It-Yourself/Formatting_Text More Formatting from Wikipedia]
-
Shakespeare, William. Othello (V, ii, 343-344).
+
{{Languages|Help:Formatting}}
-
you would format your reference as follows:
+
[[Category:Help|Formatting]]
-
 
+
-
"Then must you speak
+
-
Of One that lov'd not wisely but too well."<nowiki><ref>Shakespeare, William. Othello (V, ii, 343-344).</ref></nowiki>
+
-
 
+
-
Then when you insert
+
-
== References == <nowiki><references /></nowiki>
+
-
 
+
-
at the end of your article, the website will automatically generate a numbered footnote list for you, as below:
+
-
 
+
-
# Shakespeare, William. Othello (V, ii, 343-344).
+
-
 
+
-
 
+
-
== Bold, Italics, Etc. ==
+
-
Text formatting is usually applied by adding simple markup, known as wikitext, to your text. This table shows you what to type to get your desired results. Until we develop our own guide here, you'll be most helped by the [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheat sheet at Wikipedia].
+
-
 
+
-
 
+
-
== Creating Tables ==
+
-
You can use standard HTML code to make tables, or you can use special wikitext markup to do so. Again, the [http://en.wikipedia.org/wiki/Help:Table guide at Wikipedia] will serve as your best reference until we are able to develop our own here!
+
-
 
+
-
 
+
-
== Creating Links ==
+
-
Although hyperlinks will be rare in any of the translations we produce, there will be times when book summary pages, the Help section, or other areas of the site will need to make use of them. The list below gives some basic guidance which should suffice.
+
-
* Make a link to the page called Sandbox by typing <code><nowiki>[[Sandbox]]</nowiki></code>. Result: [[Sandbox]]
+
-
* Name a link to the page called Sandbox "The Sandbox" by typing <code><nowiki>[[Sandbox|The Sandbox]]</nowiki></code>. Result: [[Sandbox|The Sandbox]]
+
-
* Make a link to Google (or any other external site) by typing <code><nowiki>http://www.google.com</nowiki></code>: Result: http://www.google.com
+
-
* Name a link to Google "Search the web" by typing by typing <code><nowiki>[http://www.google.com Search the web]</nowiki></code>: Result: [http://www.google.com Search the web]
+

Revision as of 22:37, 24 December 2008

PD
 Please note: All pages in this Help Section are public domain content borrowed from Mediawiki. Please report any broken links or incorrect information to us at the contact page.

You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two single quotes like ''this''

Contents

Text formatting markup

Description You type You get
applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Escape wiki markup <nowiki>no "markup"</nowiki> no ''markup''
Fixed width text

<tt>Fixed width text</tt>

Fixed width text

only at the beginning of the line
Indent text

:Single indent
::Double indent
:::::Multiple indent

Single indent
Double indent
Multiple indent
Headings of

different levels [1]

=level 1=[2]
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

Level 1

Level 2

Level 3
Level 4
Level 5
Level 6

Horizontal rule

----

Bullet list

* one
* two
* three
** three point one
** three point two
  • one
  • two
  • three
    • three point one
    • three point two
Numbered list

# one
# two<br />spanning several lines<br />without breaking the numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning several lines
    without breaking the numbering
  3. three
    1. three point one
    2. three point two
Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two
  1. one
  2. two
    • two point one
    • two point two
Definition list

;Definition
:item 1
:item 2
Definition
item 1
item 2
Preformatted text

  preformatted text is done with
  a space at the
  beginning of the line

 
preformatted text is done with
a space at the 
beginning of the line
Preformatted text with no indentation

 <pre> some preformatted text with no indentation </pre> 

some preformatted
text with no indentation
Blockquotes

Body
text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text

Body
text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text

Comment

<!--This is comment-->


Notes:
  1. ↑ An article with four or more headings will automatically create a table of contents.
  2. ↑ Use of a level 1 heading is highly discouraged as it appears with the same formatting and size as the page title, which can be confusing.

Paragraphs

MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <br> or <br/>.

HTML

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>.

Tools.svg Tip for wiki admins: If you trust your users you can allow full HTML by setting $wgRawHtml = true; in LocalSettings.php.


Other formatting

Beyond the text formatting markup shown above, here are some other formatting references:

Languages:  English
Retrieved from "http://en.gospeltranslations.org/wiki/Help:Formatting"
Navigation
Volunteer Tools
Other Wikis
Toolbox