Alpine Linux:Markup syntax: Difference between revisions

From Alpine Linux
(→‎Block elements: heavy reworking)
(redirect to Help:Editing)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Inline elements ==
#REDIRECT [[Help:Editing]]
 
* ''<nowiki>''italic''</nowiki>'' or use <i>&lt;i></i> or <em>&lt;em></em> or {font-style:italic} in a style attribute
* '''<nowiki>'''bold'''</nowiki>''' or use <b>&lt;b></b> or <strong>&lt;strong></strong> or {font-weight:bold} in a style attribute
<!-- <b><nowiki>''''</nowiki></b>''''bold and italic''''<b><nowiki>''''</nowiki></b> -->
 
* <small>&lt;small></small> or use {font-size:smaller} in a style attribute
* <big>&lt;big></big> or use {font-size:larger} in a style attribute (invalid in HTML5)
* <sup>&lt;sup></sup> or use {vertical-align:super} in a style attribute
* <sub>&lt;sub></sub> or use {vertical-align:sub} in a style attribute
<!--
Here is a footnote.<ref>Insert footnote text here.</ref>
Here is a recallable footnote.<ref name="foo">Recallable footnote.</ref>; now let's recall it.<ref name="foo" />
References: {{reflist}}
-->
 
* &lt;font> is deprecated; use {font-size:10pt; color:red; font-family:"Courier"} in a style attribute
* <nowiki><span style="</nowiki><span style="color:gray">color:gray</span>"&gt;
* <nowiki><span style="</nowiki><span style="color:white; background:red;">color:white; background:red</span>"&gt;
* <u>&lt;u></u> or use <ins>&lt;ins></ins> or {text-decoration:underline} in a style attribute (&lt;u> is valid in HTML5 but not HTML4/strict; &lt;ins> can also be a block element)
* <s>&lt;s></s> or use <del>&lt;del></del> or {text-decoration:line-through} in a style attribute (&lt;s> is valid in HTML5 but not HTML4/strict; &lt;del> can also be a block element)
<!-- <strike> also works, but is deprecated -->
 
* <code>&lt;code></code> uses {font-family:monospace;} (&lt;tt> is invalid in HTML5)
*: <code><var>markup</var> and &rarr; entities are still honored</code>
* <kbd> and <samp> and <q> and <dfn> are not processed by this wiki
 
* <var>&lt;var></var>
* <cite>&lt;cite></cite>
* <nowiki>{{Hint|</nowiki>{{Hint|term|explanation}}<nowiki>|explanation}}</nowiki>
* <nowiki>{{Path|</nowiki>{{Path|/a/path/name}}<nowiki>}}</nowiki>
* {{Lb}}Key| {{Key|Ctrl}}{{Rb}}+{{Lb}}Key| {{Key|C}}{{Rb}}
 
* Here is one line, followed by &lt;br /><br /><!-- a line break here terminates the list item --> and another line.
 
* Here is &lt;!-- a comment -->.
 
 
=== Links ===
 
Here is <nowiki>[[Wiki pagetitle|a wiki page]]</nowiki>: [[Wiki pagetitle|a wiki page]]. Text immediately suffixing the link will be incorporated into the link text; separate with &lt;nowiki /> to suppress.
 
Here is <nowiki>{{Pkg|gtk+2.0}}</nowiki>: {{Pkg|gtk+2.0}}.
 
Here is an [http://bugs.alpinelinux.org/ Alpine Issue] link <nowiki>{{Issue|279}}</nowiki>: {{Issue|279}}. The issue's description can be included as an optional second argument.
 
Here is <nowiki>[http://www.example.org/ an external link]</nowiki>: [http://www.example.org/ an external link]. If no link text is supplied: [http:///www.example.org]. Omit brackets for http://www.example.org/<nowiki /> (use &lt;nowiki> to suppress). <!-- This wiki's server can be specified using <nowiki>{{SERVERNAME}}</nowiki>. -->
 
<nowiki>[mailto:</nowiki>[mailto:info@example.org info@example.org]<nowiki>?Subject=URL%20Encoded%20Subject&body=Body%20Text info]</nowiki>.
 
In Talk pages, <nowiki>-- ~~~~</nowiki> gives a signature and timestamp: -- [[User:Dubiousjim|Dubiousjim]] 10:00, 4 March 2012 (UTC)
 
<!--
In general when pointing to Alpine Linux downloads stick with the '''[[Downloads|Downloads Page]]''', but if you for any reason need to include direct download information, do so by using one of below.
 
==== Download Links ====
*<code><nowiki>{{#latestalp:alpine|url}}</nowiki></code> will give you latest download url for Alpine Linux Standard:<br/>
:{{#latestalp:alpine|url}}
*<code><nowiki>{{#latestalp:alpine-mini|url}}</nowiki></code> will give you latest download url for Alpine Linux mini:<br/>
:{{#latestalp:alpine|url}}
<big>'''Example:'''</big><br/>
Start from <nowiki>[{{#latestalp:alpine|url}}</nowiki> Downloading latest Alpine Linux Standard], than continue ...
'''produces:'''<br/>
Start from [{{#latestalp:alpine|url}} Downloading latest Alpine Linux Standard], than continue ...
 
==== Download Boxes ====
{| cellspacing="3"
|- valign="top"
|width="33%" class="ClassForFutureCSS" |
<div style="padding: .4em .9em .1em">
<p style="text-align:center"><code><nowiki>{{Download|alpine}}</nowiki></code></p>
For standard</div>
|width="33%" class="ClassForFutureCSS" |
<div style="padding: .4em .9em .1em">
<p style="text-align:center"><code><nowiki>{{Download|alpine-mini}}</nowiki></code></p>
For mini</div>
|width="33%" class="ClassForFutureCSS" |
<div style="padding: .4em .9em .1em">
<p style="text-align:center"><code><nowiki>{{DownloadDev|alpine}}</nowiki></code></p>
For standard</div>
|- valign="top"
| <div style="padding: .4em .9em .9em"><center>{{Download|alpine}}</center></div>
| <div style="padding: .4em .9em .9em"><center>{{Download|alpine-mini}}</center></div>
| <div style="padding: .4em .9em .9em"><center>{{DownloadDev|alpine}}</center></div>
|}
-->
 
== Headings ==
 
An article with 4 or more headings automatically creates a table of contents. You can force a table of contents (or fine-tune its placement) by inserting <nowiki>__TOC__</nowiki>. You can suppress the table of contents by inserting <nowiki>__NOTOC__</nowiki>.
 
Start headings at level 2, and don't skip levels.
 
<pre>== Heading2 ==</pre>
will produce:
<h2>Heading2</h2>
 
<pre>=== Heading3 ===</pre>
will produce:
<h3>Heading3</h3>
 
<pre>==== Heading4 ====</pre>
will produce:
<h4>Heading4</h4>
 
 
<pre>{{Delete|Message.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f1f1de; border:1px solid #cc9; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Tango-user-trash-full.png|48px|left|link=]] This material is proposed for deletion ... </div><p style="text-align: center; font-size: 87%;">Message.
([[{{TALKPAGENAME}}|Discuss]]) Make sure no other pages link here and check the page's history before deleting.</p>
|}</center>
 
<pre>{{Obsolete|Alternate message.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f1f1de; border:1px solid #cc9; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Out_of_date_clock_icon.svg‎|54px|left|link=]] This material is obsolete ... </div><p style="text-align: center; font-size: 87%;">Alternate message.
([[{{TALKPAGENAME}}|Discuss]])</p>
|}</center>
 
<pre>{{Merge|Page to merge with|Additional message.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f6f6f6; border:1px solid #aaa; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Tango-two-arrows.png‎|75px|left|link=]] This material is proposed for merging ... </div><p style="text-align: center; font-size: 87%;">It should be merged with [[Page to merge with]].{{Ifn|Additional message.| Additional message.}}
([[{{TALKPAGENAME}}|Discuss]])</p>
|}</center>
 
<pre>{{Move|New page name|Reason.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f6f6f6; border:1px solid #aaa; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Tango-go-next.png‎|48px|left|link=]] This page is proposed for moving ... </div><p style="text-align: center; font-size: 87%;">It should be renamed to [[New page name]]. Reason.
([[{{TALKPAGENAME}}|Discuss]])</p>
|}</center>
 
<pre>{{Draft|Alternate message.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f6f6f6; border:1px solid #aaa; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Underconstruction_clock_icon_gray.svg‎|64px|left|link=]] This material is work-in-progress ... </div><p style="text-align: center; font-size: 87%;">Alternate message. <i>(Last edited by
{{REVISIONUSER}} on {{REVISIONDAY}} {{Month|{{REVISIONMONTH}}}} {{REVISIONYEAR}}.)</i></p>
|}</center>
 
<pre>{{Expand|Alternate message.}}</pre>
will produce:
<center>
{|style="width: 48em; padding:2px; margin:0; margin-bottom:10px; background-color:#f6f6f6; border:1px solid #aaa; -moz-border-radius-bottomright: 0.5em; -moz-border-radius-bottomleft: 1em; border-radius-bottomright: 0.5em; border-radius-bottomleft: 1em; -webkit-border-bottom-right-radius: 0.5em; -webkit-border-bottom-left-radius: 1em;"
|<div style="font-size: 1.5em; font-weight:bold; text-align:center;"> [[Image:Tango-view-fullscreen.png‎|48px|left|link=]] This material needs expanding ... </div><p style="text-align: center; font-size: 87%;">Alternate message.</p>
|}</center>
 
== Block elements ==
 
=== Lists ===
 
<pre>
# Here is a numbered list item.
## Doubly-numbered
#* Numbered and bulleted.
 
* Here is a bulleted list item.
** Doubly-bulleted
*# Bulleted and numbered.
*# Another item.
</pre>
 
will produce:
# Here is a numbered list item.
## Doubly-numbered
#* Numbered and bulleted.
 
* Here is a bulleted list item.
** Doubly-bulleted
*# Bulleted and numbered.
*# Another item.
 
Blank lines, or non-bulleted/numbered lines, end the lists.
 
 
Each of these:
<pre>
;item: Body text
{{Define|item|Body text}}
</pre>
 
will produce:
;item: Body text
 
The second markup option also wraps a <code><nowiki><span id="item"></nowiki></code> around the block.
 
 
=== Indenting unstyled text ===
 
<pre>
: Simply indented text (on left side only).
 
<blockquote>This is a blockquote.
It collapses whitespace, and indents on both sides.</blockquote>
</pre>
 
will produce:
: Simply indented text (on left side only).
 
<blockquote>This is a blockquote.
It collapses whitespace, and indents on both sides.</blockquote>
 
<!--
<center> is deprecated; use <div class="center" style="width:auto; margin-left:auto; margin-right:auto;">Centered text</div>
-->
 
 
=== Displaying code ===
 
<dl>
<dt>Inline code
<dd>Use <code>&lt;code></code> for styling, and <code>&lt;nowiki></code> to suppress markup. If you use both, they must appear in that order. <code>&lt;nowiki></code> <nowiki>converts &rarr; entities and collapses whitespace </nowiki>(even multiple <code>\n</code>s),<nowiki> but ignores all '''wiki''' and <span style="color:green">HTML</span> [[markup]]</nowiki>.
 
 
<dt>User input
<dd>{{Cmd|{{lb}}[[Template:Cmd|Cmd]]{{!}}a &lt;var><var>command</var>&lt;/var> to try{{rb}}}}
This is a block-level equivalent for the inline HTML element <kbd> (which the wiki does not process). Note that wiki markup is still honored in the command text; but whitespace is not collapsed.
 
 
<dt>Command output; or shell sessions that intermix prompts, user input, and command output; or segments of files
<dd>Use space-indented blocks or <code>&lt;pre></code>:
<pre>
Every line
begins with '''a space'''.
 
<pre>
Lines aren't
indented with '''a space.'''
&lt;/pre>
 
&lt;nowiki>Only first
line begins with '''a space'''.&lt;/nowiki>
</pre>
 
will produce:
 
Every line
begins with '''a space'''.
 
<pre>
Lines aren't
indented with '''a space.'''
</pre>
 
<nowiki>Only first
line begins with '''a space'''.</nowiki>
 
All of these render as styled blocks, in monospace, and don't collapse whitespace. They are block-level equivalents for the inline HTML elements <code>&lt;code></code> or <code>&lt;samp></code> (which the wiki does not process).
 
All of these markup options convert &rarr; entities. The first also processes <nowiki>'''wiki''' and <span style="color:green">HTML</span> [[markup]]</nowiki>.
<!-- Can contain any inline element except: IMG OBJECT BIG SMALL SUP SUB -->
The second and the third don't; and they give equivalent presentations. With the third option, lines after the first should not be space-prefixed; the block will extend to the closing <code>&lt;/nowiki></code>.
 
<dt>File contents
<dd><pre>
{{Cat|/path/to/file|body '''text''' <br /> more
Second line.}}
</pre>
 
will produce:
{{Cat|/path/to/file|body '''text''' <br /> more
Second line.}}
Note that wiki and HTML markup in the file contents aren't coverted, though entities still are. You must escape characters as follows:
: {{=}} not inside [[..]] use &amp;#61; or {{lb}}{{=}}{{rb}}
: {{!}} not inside [[..]] use &amp;#124; or {{lb}}!{{rb}}
: {{lb}}                  use &amp;#123; twice or {{lb}}lb{{rb}}
: {{rb}}                  use &amp;#125; twice or {{lb}}rb{{rb}}
: unmatched &#91;&#91;        use &amp;#91; twice
: unmatched &#93;&#93;        use &amp;#93; twice
 
 
<dt>Block-level code with no additional styling
<dd><pre>
<p style="white-space:pre; font-family:monospace;">One line.
Second line.
</p></pre>
will produce:
<p style="white-space:pre; font-family:monospace;">One line.
Second line.
</p>
This would be the behavior of HTML's &lt;pre> without any styling. To wrap to screen width, use {white-space:pre-wrap}.
 
<!-- this extension not present
<math>
\sum_{n=0}\infty\frac{x^n}{n!}
</math>
-->
</dl>
 
=== Message Boxes ===
 
{{Warning|<nowiki>{{Warning|Write your Warning here.}}</nowiki>}}
{{Note|<nowiki>{{Note|Write your Note here.}}</nowiki>}}
{{Tip|<nowiki>{{Tip|Write your Tip here.}}</nowiki>}}
{{Todo|<nowiki>{{Todo|Write your Todo here.}}</nowiki>}}
{{Box|Heading:|<nowiki>{{Box|Heading:|Body}}</nowiki>}}
{{Box|Heading:|<nowiki>{{Box|Heading:|Body then border-color then background-color|#DF0000|#FFDFDF}}</nowiki>|#DF0000|#FFDFDF}}
 
== Tables ==
 
{{Expand}}
 
<pre>
{|  border="1" style="width:75%; height:200px"  <!-- align=right makes table float -->
|+ The table's caption
|-
! width=100px | columnlabel 1
! columnlabel 2 !! columnlabel 3
|-
! rowlabel1
| Cell 1 || Cell 2 || Cell 3
|- style="height:100px; background:none" <!-- or style="background:transparent" -->
| align=right style="width:200px" | Cell A
| style="background:red; color:white" | Cell B
| colspan=2 align=center | Cell C
|- valign=top <!-- have to be applied to every row, default is valign=middle; or use style="vertical-align:top;" -->
| rowspan=2 Cell D
| ...
|}
</pre>
 
 
See also:
* http://www.mediawiki.org/wiki/Help:Tables
* http://meta.wikimedia.org/wiki/Help:Table
 
<!--
    <table>
        <caption>
        <th>
        <tr>
        <td>
-->
 
== Images ==
 
{{Expand}}
 
<pre>[[File:Alpinelinux 01.png|right|thumb|100px|Caption text]]</pre> will produce:
 
[[File:Alpinelinux 01.png|right|thumb|100px|Caption text]]
{{Clear}}
Options can appear in any order:
* <i>Caption text</i> defaults to filename; to wholly suppress, use <code>&lt;span title="">&lt;/span></code>
* '''alt='''<i>text</i>
* Size can be [<i>width</i>][<b>x</b><i>height</i>]<b>px</b>
* '''page='''<i>number</i>, for PDF images
* rendered inline, Caption shows as hover text: '''frameless''', and/or '''border'''
** rendered inline, on separate line: '''none'''
** Valign for inline images, defaults to middle: '''middle|baseline|sub|super|top|text-top|bottom|text-bottom'''
** Text flow can be stopped by placing <nowiki>{{Clear}}</nowiki> <!-- <code>&lt;br style="clear:both" /></code> --> before the text that should start below the floating image
** '''link='''<i>URL</i>|<i>pagetitle</i>|<i>blank</i>, only for inline images
* rendered floating, defaults to right align, Caption displayed below image: '''thumb''', '''thumb='''<i>alternate filename</i>, '''frame''' (ignores size options)
** rendered floating, defaults to thumb: '''left|right|center'''
 
To instead link to the file, you need to add a colon: [[:File:Alpinelinux 01.png]].
 
See also:
* http://meta.wikimedia.org/wiki/Help:Images_and_other_uploaded_files
* http://meta.wikimedia.org/wiki/Help:Image_page
* http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax
* http://www.mediawiki.org/wiki/Help:Images
* http://www.mediawiki.org/wiki/Help:Managing_files
* http://meta.wikimedia.org/wiki/Help:Navigational_image
 
== Other ==
 
Create HRs like this:
<pre>----</pre>
 
Every page should be assigned at least one [[Special:Categories|Category]], by placing the following '''at the bottom of the page''':
<pre>[[Category:Category name]]</pre>
 
To '''link to''' a Category page, without adding the linking page to the category: <code><nowiki>[[</nowiki><b>:</b>Category:Not in this category]]</code>
 
A redirect page should contain only:
<pre>#REDIRECT [[pagename]]</pre>
 
== See also ==
 
* [[Alpine Linux Wiki templates|Wiki templates]].
* http://www.mediawiki.org/wiki/Help:Formatting
* http://meta.wikimedia.org/wiki/Help:HTML_in_wikitext
* http://en.wikipedia.org/wiki/Help:HTML_in_wikitext
* http://en.wikipedia.org/wiki/Help:Wiki_markup
 
There may be small divergences, but in general, ours seems to be just a standard MediaWiki installation.
 
[[Category:Wiki]]

Latest revision as of 12:19, 24 March 2012

Redirect to:

Retrieved from "https://wiki.alpinelinux.org/w/index.php?title=Alpine_Linux:Markup_syntax&oldid=7467"