Help:Me: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(https)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This wiki is a "MediaWiki" - like [http://en.wikipedia.org/ Wikipedia], and also like the Mozilla intranet. MediaWikis use a simple form of markup to enrich plain text. This is a cheat sheet; the [[Help:Editing|standard editing help page]] is... comprehensive. Lots of trees, hard to see the wood. If you bookmark this page, then whenever you need it, just type "Help Me" into your Awesomebar.
__NOTOC__


Type things from the left into the page editing box of the page you are editing, and the result will be what you see on the right.
This wiki is powered by "MediaWiki" - like [http://en.wikipedia.org/ Wikipedia], and also like the Mozilla intranet. MediaWiki uses a simple form of markup to enrich plain text. This is a cheat sheet; the [[Help:Editing|standard editing help page]] is... comprehensive. Lots of trees, hard to see the wood. If you bookmark this page then you can just type "Help Me" into your Awesomebar whenever you need it.


<div style="width: 50%; float:right; border-left: 2px black solid; padding-left: 1em; padding-right: 1em;">
If you have text already marked up with HTML, much of it will Just Work. Paste it in to the Edit box, press "Show preview", and see how it looks. (Sadly, links don't work - you have to convert them to using the syntax below.) You can mix HTML and MediaWiki markup in the same page.
==Heading==
===Smaller Heading (More Equals Signs; Use Up To 5)===


Separate your paragraphs with a blank line.<br>
Type things from the left into the page editing box of the page you are editing, and the result will be what you see on the right. If you want to experiment without messing up anything important, practise by editing your [[Special:MyPage|personal user page]].
Explicit line breaks are also possible, e.g. for poetry.


# Numbered list - start with a #
{|
 
|<tt><nowiki>==Heading==</nowiki></tt>
* Bulleted list - start with a *
|
** Sub-bulleted list - multiple *s
==Heading==
 
|-
A blank line finishes a list.
|<tt><nowiki>===Smaller heading (more 'equals' signs; use up to 5)===</nowiki></tt>
 
|
[[Help:Editing|Links within the wiki]] - two square brackets on either side, with link text separated from page name by a | (pipe).  
===Smaller heading (more 'equals' signs; use up to 5)===
 
|-
[http://www.mozilla.org/ Links to other sites] - one square bracket and a space separator for the link text. You ''will'' get these two forms mixed up. :-|
|<tt>Separate your paragraphs with a blank line, just like in plain text.<br>
 
Otherwise text just flows, even past a single newline.<br>
   Start a line with whitespace to have it rendered like this - good for quotations, code etc.
Explicit line breaks are also possible, e.g. for poetry, like this: <nowiki><br></nowiki><br>
 
This is on a new line.</tt>
'''Three single quotes for bold'''. ''Two for italics''.
|
</div>
Separate your paragraphs with a blank line, just like in plain text.
 
Otherwise text just flows, even past a single newline.
<div style="font-family: monospace; font-size: medium">
Explicit line breaks are also possible, e.g. for poetry, like this: <br>
<br>
This is on a new line.
<nowiki>==Heading==</nowiki>
|-
<br>
|<tt>* Bulleted list - first character on the line is a *<br>
 
<nowiki>**</nowiki> Sub-bulleted list - multiple *s, but still first characters on the line</tt>
<nowiki>===Smaller Heading (More Equals Signs; Use Up To 5)===</nowiki>
|
<br>
* Bulleted list - first character on the line is a *
<br>
** Sub-bulleted list - multiple *s, but still first characters on the line
|-
|<tt># Numbered list - first character on the line is a #
<nowiki>#</nowiki> Here's another item<br>
<nowiki>#</nowiki> A blank line finishes a list, so don't put one in unless that's what you want</tt>
|
# Numbered list - first character on the line is a #
# Here's another item
# A blank line finishes a list, so don't put one in unless that's what you want
|-
|<tt><nowiki>[[Help:Editing|Links within the wiki]]</nowiki> - two square brackets on either side. The (optional) link text is separated from the page name by a <nowiki>|</nowiki> (pipe).</tt>
|[[Help:Editing|Links within the wiki]] - two square brackets on either side. The (optional) link text is separated from the page name by a <nowiki>|</nowiki> (pipe).
|-
|<tt><nowiki>[http://www.mozilla.org/ Links to other sites]</nowiki> - one square bracket, and a space separator for the link text. You ''will'' get these two forms mixed up. <nowiki>:-|</nowiki> Simpler but more ugly - just type the URL and it will autolinkify: <nowiki>http://www.mozilla.org/</nowiki></tt>
|[http://www.mozilla.org/ Links to other sites] - one square bracket, and a space separator for the link text. You ''will'' get these two forms mixed up. <nowiki>:-|</nowiki> Simpler but more ugly - just type the URL and it will autolinkify: https://www.mozilla.org/
|-
|<tt>&nbsp;&nbsp;Start a line with whitespace to have it rendered like this,<br>&nbsp;&nbsp;as 'preformatted' - good for code, program output etc.</tt>
|
   Start a line with whitespace to have it rendered like this,
  as 'preformatted' - good for code, program output etc.
|-
|<tt><nowiki>'''Three single quotes for bold'''.</nowiki></tt>
|'''Three single quotes for bold'''.
|-
|<tt><nowiki>''Two single quotes for italics''.</nowiki></tt>
|''Two single quotes for italics''.
|-
|<tt><nowiki><tt>TT for a monospace font, e.g. for technical terms or code</tt>.</nowiki></tt>
|<tt>TT for a monospace font, e.g. for technical terms or code</tt>.
|-
|<tt><nowiki>Upload images, PDFs, documents etc. using the [[Special:Upload]] page, and make a link to them [[media:Devbeast.png|like this]]. Display images directly in the page like this:</nowiki><br><nowiki>
[[Image:Devbeast.png]]</nowiki></tt>
|Upload images, PDFs, documents etc. using the [[Special:Upload]] page, and make a link to them [[media:Devbeast.png|like this]]. Display images directly in the page like this:
[[Image:Devbeast.png]]
|-
|<tt><nowiki>"Templates" use two curly brackets to include standard snippets of text by name. E.g. {{bug|123456}} links to a bug. See below for a handy list.</nowiki></tt>
|"Templates" use two curly brackets to include standard snippets of text. E.g. {{bug|123456}} links to a bug. See below for a handy list.
|}


Separate your paragraphs with a blank line.<nowiki><br></nowiki><br>
===Useful Templates===
Explicit line breaks are also possible, e.g. for poetry.


<nowiki># Numbered list - start with a #</nowiki><br>
Templates are implemented by wiki pages prefixed with "Template:" (such as [[Template:MDN]]) containing boilerplate markup, sometimes complicated expressions, and ideally some documentation. They differ between wikis.


<nowiki>* Bulleted list - start with a *</nowiki><br>
{| width="100%" border=1
<nowiki>** Sub-bulleted list - multiple *s</nowiki><br>
|<tt><nowiki>{{draft}}</nowiki></tt> - worth putting at the top of all unfinished pages, for clarity
|{{draft}}
|-
|<tt><nowiki>{{bug|123456}}</nowiki></tt> - link to a bug in Mozilla's Bugzilla
|{{bug|123456}}
|-
|<tt><nowiki>{{warning|Danger! Rampaging memes!}}</nowiki></tt> - issue a warning of some sort
|{{warning|Danger! Rampaging memes!}}
|-
|<tt><nowiki>{{outdated}}</nowiki></tt> - simple, common form of warning for outdated pages
|{{warning|<b>The content of this article may be out of date.</b>}} <!-- Not using the real template because it categorizes this page as outdated! -->
|}


A blank line finishes a list.
===A Little More Advanced===


<nowiki>[[Help:Editing|Links within the wiki]] - two square brackets on either side, with link text separated from page name by a | (pipe).</nowiki>
The below capabilities are also useful to know about:


<nowiki>[http://www.mozilla.org/ Links to other sites] - one square bracket and a space separator for the link text. You ''will'' get these two forms mixed up. :-|</nowiki>
* If two pages have duplicate information, you can consolidate onto a single page and have the other page redirect to the new best source. You do that by removing all the text and replacing it with:
<br>
<br>


<nowiki>&nbsp;&nbsp;Start a line with whitespace to have it rendered like this - good for quotations, code etc.</nowiki>
  <nowiki>#REDIRECT [[pagename]]</nowiki>
<br>


<nowiki>'''Three single quotes for bold'''. ''Two for italics''.</nowiki>
e.g.
</div>


<div style="clear: both">
  <nowiki>#REDIRECT [[Help:Me]]</nowiki>
<br>
Lastly, if you have text already marked up with HTML, much of it will Just Work. Paste it in to the Edit box, press "Show preview", and see how it looks. You can mix HTML and MediaWiki markup.
</div>

Latest revision as of 19:11, 4 December 2024


This wiki is powered by "MediaWiki" - like Wikipedia, and also like the Mozilla intranet. MediaWiki uses a simple form of markup to enrich plain text. This is a cheat sheet; the standard editing help page is... comprehensive. Lots of trees, hard to see the wood. If you bookmark this page then you can just type "Help Me" into your Awesomebar whenever you need it.

If you have text already marked up with HTML, much of it will Just Work. Paste it in to the Edit box, press "Show preview", and see how it looks. (Sadly, links don't work - you have to convert them to using the syntax below.) You can mix HTML and MediaWiki markup in the same page.

Type things from the left into the page editing box of the page you are editing, and the result will be what you see on the right. If you want to experiment without messing up anything important, practise by editing your personal user page.

==Heading==

Heading

===Smaller heading (more 'equals' signs; use up to 5)===

Smaller heading (more 'equals' signs; use up to 5)

Separate your paragraphs with a blank line, just like in plain text.

Otherwise text just flows, even past a single newline.
Explicit line breaks are also possible, e.g. for poetry, like this: <br>
This is on a new line.

Separate your paragraphs with a blank line, just like in plain text. Otherwise text just flows, even past a single newline. Explicit line breaks are also possible, e.g. for poetry, like this:
This is on a new line.

* Bulleted list - first character on the line is a *

** Sub-bulleted list - multiple *s, but still first characters on the line

  • Bulleted list - first character on the line is a *
    • Sub-bulleted list - multiple *s, but still first characters on the line
# Numbered list - first character on the line is a #

# Here's another item
# A blank line finishes a list, so don't put one in unless that's what you want

  1. Numbered list - first character on the line is a #
  2. Here's another item
  3. A blank line finishes a list, so don't put one in unless that's what you want
[[Help:Editing|Links within the wiki]] - two square brackets on either side. The (optional) link text is separated from the page name by a | (pipe). Links within the wiki - two square brackets on either side. The (optional) link text is separated from the page name by a | (pipe).
[http://www.mozilla.org/ Links to other sites] - one square bracket, and a space separator for the link text. You will get these two forms mixed up. :-| Simpler but more ugly - just type the URL and it will autolinkify: http://www.mozilla.org/ Links to other sites - one square bracket, and a space separator for the link text. You will get these two forms mixed up. :-| Simpler but more ugly - just type the URL and it will autolinkify: https://www.mozilla.org/
  Start a line with whitespace to have it rendered like this,
  as 'preformatted' - good for code, program output etc.
 Start a line with whitespace to have it rendered like this,
 as 'preformatted' - good for code, program output etc.
'''Three single quotes for bold'''. Three single quotes for bold.
''Two single quotes for italics''. Two single quotes for italics.
<tt>TT for a monospace font, e.g. for technical terms or code</tt>. TT for a monospace font, e.g. for technical terms or code.
Upload images, PDFs, documents etc. using the [[Special:Upload]] page, and make a link to them [[media:Devbeast.png|like this]]. Display images directly in the page like this:
[[Image:Devbeast.png]]
Upload images, PDFs, documents etc. using the Special:Upload page, and make a link to them like this. Display images directly in the page like this:

Devbeast.png

"Templates" use two curly brackets to include standard snippets of text by name. E.g. {{bug|123456}} links to a bug. See below for a handy list. "Templates" use two curly brackets to include standard snippets of text. E.g. bug 123456 links to a bug. See below for a handy list.

Useful Templates

Templates are implemented by wiki pages prefixed with "Template:" (such as Template:MDN) containing boilerplate markup, sometimes complicated expressions, and ideally some documentation. They differ between wikis.

{{draft}} - worth putting at the top of all unfinished pages, for clarity
Draft-template-image.png THIS PAGE IS A WORKING DRAFT Pencil-emoji U270F-gray.png
The page may be difficult to navigate, and some information on its subject might be incomplete and/or evolving rapidly.
If you have any questions or ideas, please add them as a new topic on the discussion page.
{{bug|123456}} - link to a bug in Mozilla's Bugzilla bug 123456
{{warning|Danger! Rampaging memes!}} - issue a warning of some sort
Warning signWarning: Danger! Rampaging memes!
{{outdated}} - simple, common form of warning for outdated pages
Warning signWarning: The content of this article may be out of date.

A Little More Advanced

The below capabilities are also useful to know about:

  • If two pages have duplicate information, you can consolidate onto a single page and have the other page redirect to the new best source. You do that by removing all the text and replacing it with:
 #REDIRECT [[pagename]]

e.g.

 #REDIRECT [[Help:Me]]