JHelp

Difference between revisions of "Cheatsheet"

From Joomla! Documentation

m (edit shortcut link)
m (Reverted edits by TaDrik (talk) to last revision by Sandra97)
 
(16 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
<!--COMMENT MARKUP. Displays:Edit mode only.-->
 
<!--COMMENT MARKUP. Displays:Edit mode only.-->
 
{|align="center" style="width:100%; border:2px #a3b1bf solid; background:#f5faff; text-align:left;"
 
{|align="center" style="width:100%; border:2px #a3b1bf solid; background:#f5faff; text-align:left;"
|colspan="3" align="center" style="background:#cee0f2; text-align:center;" | {{shortcut|JDOC:CHEAT|JDOC:EDIT}}
+
|colspan="3" align="center" style="background:#5091cd; text-align:center;" | {{shortcut|JDOC:CHEAT|JDOC:EDIT}}
<h2 style="margin:.5em; margin-top:.1em; margin-bottom:.1em; border-bottom:0; font-weight:bold;">Joomla Documenation Wiki Cheatsheet</h2>  
+
{{section portal heading|icon=magic|title=Joomla Documentation Wiki Cheatsheet}}
 +
|-<!--WORKS ONLY AT THE BEGINNING OF LINES-->
 +
| colspan="3" style="background:#c5d6e8; border-top:2px #a3b1bf solid; font-size:1.4em" |
 +
<center>'''Works only at the beginning of lines''' &nbsp; &nbsp;
 +
|-<!--COLUMN HEADINGS--> style="background:#c5d6e8; padding:0.3em; font-size: 0.9em; text-align:center;"
 +
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
 +
| style="border-bottom:2px #a3b1bf solid" | You type
 +
| style="border-bottom:2px #a3b1bf solid" width="30%" | You get
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Section headings'''{{Anchor|Section headings}}<br />
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">These are equivalent to using <nowiki><h2>, <h3>, <h4>, etc.. header tags</nowiki><br/></nowiki>''a Table of Contents will automatically be generated when four headings are added to an article''</div>
 +
|
 +
<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><br /><br />
 +
<span style="font-size:0.9em">''do not use''&nbsp; =Level 1=&nbsp; ''as it is for page titles''</span>
 +
|
 +
 
 +
==Level 2==
 +
===Level 3===
 +
====Level 4====
 +
=====Level 5=====
 +
======Level 6======
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Nonindexed headers'''<div style="font-size:0.9em;">
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''left out of Table of Contents''</div>
 +
|
 +
<tt><nowiki>; Header name</nowiki></tt><br />
 +
<div style="font-size:0.9em;">''has a leading semicolon'' ";" ''in front''</div>
 +
|
 +
'''Header name'''<br />
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''will not appear in Table of Contents''</div>
 +
 
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Bulleted list'''<br/>Use the asterisk(*){{Anchor|Bulleted list}}
 +
|
 +
<tt>* One</tt><br />
 +
<tt>* Two</tt><br />
 +
<tt>** Two point one</tt><br />
 +
<tt>* Three</tt>
 +
|
 +
* One
 +
* Two
 +
** Two point one
 +
* Three
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Numbered list'''<br/>Use the hash tag(number sign-(#)){{Anchor|Numbered list}}
 +
|
 +
<tt># One</tt><br />
 +
<tt># Two</tt><br />
 +
<tt>## Two point one</tt><br />
 +
<tt># Three</tt>
 +
|
 +
# One
 +
# Two
 +
## Two point one
 +
# Three
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Indenting text'''{{Anchor|Indenting text}}
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''this is used when replying on a [[JDOC:Tutorial (Talk pages)|talk page]], to make it easier to follow conversations''</div>
 +
|
 +
<tt><nowiki>no indent (normal)</nowiki></tt><br />
 +
<tt><nowiki>:first indent</nowiki></tt><br />
 +
<tt><nowiki>::second indent</nowiki></tt><br />
 +
<tt><nowiki>:::third indent</nowiki></tt>
 +
|
 +
no indent (normal)<br />
 +
:first indent
 +
::second indent
 +
:::third indent
 
|-<!--WORKS ANYWHERE IN THE TEXT-->
 
|-<!--WORKS ANYWHERE IN THE TEXT-->
| colspan=3 style="background:#E6F2FF; border-top:2px #a3b1bf solid" |
+
| colspan=3 style="background:#c5d6e8; border-top:2px #a3b1bf solid; font-size:1.4em" |
 
<center>'''Works anywhere in the text''' &nbsp; &nbsp; &nbsp; &nbsp;
 
<center>'''Works anywhere in the text''' &nbsp; &nbsp; &nbsp; &nbsp;
|-<!--COLUMN HEADINGS--> style="background:#E6F2FF; padding:0.3em; font-size: 0.9em; text-align:center;"
+
|-<!--COLUMN HEADINGS--> style="background:#c5d6e8; padding:0.3em; font-size: 0.9em; text-align:center;"
 
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
 
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
 
| style="border-bottom:2px #a3b1bf solid" | You type
 
| style="border-bottom:2px #a3b1bf solid" | You type
Line 86: Line 167:
 
|
 
|
 
[[Special:Mypage|Username]] ([[Special:Mytalk|talk]]) {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
 
[[Special:Mypage|Username]] ([[Special:Mytalk|talk]]) {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
 +
|-
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|'''Display as Code'''
 +
|
 +
<tt><nowiki><tt>JFactory::getApplication()</tt></nowiki></tt>
 +
|
 +
<tt>JFactory::getApplication()</tt>
 
|-
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
Line 123: Line 212:
 
|-
 
|-
 
|'''[[JDOC:Picture tutorial|Show an image]]'''
 
|'''[[JDOC:Picture tutorial|Show an image]]'''
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Introduction to uploading images|intro to uploading images]]
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Uploading a File|intro to uploading images]]
 
''</div>
 
''</div>
 
{{Anchor|Thumbnail image}}
 
{{Anchor|Thumbnail image}}
Line 131: Line 220:
 
[[File:Documentation_all_together_transparent.png|thumb|Caption]]
 
[[File:Documentation_all_together_transparent.png|thumb|Caption]]
 
|-
 
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
+
|'''[[JDOC:Picture tutorial|Float an image]]'''
|-
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Uploading Files#Images|intro to uploading images]]
|Add a page to a '''category'''{{Anchor|Add a page to a category}}
+
''</div>
|<tt><nowiki>[[Category:Category name]]</nowiki></tt><br /><br /><span style="font-size:0.9em;">''place near the bottom of a page''</span>
+
{{Anchor|Thumbnail image}}
|<span style="font-size:0.9em;">''shows''</span> "Category name" <span style="font-size:0.9em;">''in a bar at bottom when the page is previewed or saved''</span>
 
 
 
|-<!--WORKS ONLY AT THE BEGINNING OF LINES-->
 
| colspan="3" style="background:#E6F2FF; border-top:2px #a3b1bf solid" |
 
<center>'''Works only at the beginning of lines''' &nbsp; &nbsp;
 
|-<!--COLUMN HEADINGS--> style="background:#E6F2FF; padding:0.3em; font-size: 0.9em; text-align:center;"
 
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
 
| style="border-bottom:2px #a3b1bf solid" | You type
 
| style="border-bottom:2px #a3b1bf solid" width="30%" | You get
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|'''Section headings'''{{Anchor|Section headings}}<br />
 
<div style="padding: 0.7em .5em; font-size:0.9em;">''a Table of Contents will automatically be generated when four headings are added to an article''</div>
 
 
|
 
|
<tt><nowiki>==Level 2==</nowiki></tt><br />
+
<nowiki>[[</nowiki>File:Documentation_all_together_transparent.png|left<nowiki>]]</nowiki><br/><br/><nowiki>[[</nowiki>File:Documentation_all_together_transparent.png|right<nowiki>]]</nowiki>
<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><br /><br />
 
<span style="font-size:0.9em">''do not use''&nbsp; =Level 1=&nbsp; ''as it is for page titles''</span>
 
 
|
 
|
 
+
[[File:Documentation_all_together_transparent.png|75px|left]]{{-}}
==Level 2==
+
[[File:Documentation_all_together_transparent.png|75px|right]]{{-}}
===Level 3===
 
====Level 4====
 
=====Level 5=====
 
======Level 6======
 
 
|-
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|-
|'''Nonindexed headers'''<div style="font-size:0.9em;">
+
|Add a page to a '''category'''{{Anchor|Add a page to a category}}
<div style="padding: 0.7em .5em; font-size:0.9em;">''left out of Table of Contents''</div>
+
|<tt><nowiki>[[Category:Category name{{#translation:}}]]</nowiki></tt><br /><br /><span style="font-size:0.9em;">''place near the bottom of a page''</span>
|
+
|<span style="font-size:0.9em;">''shows''</span> "Category name" <span style="font-size:0.9em;">''in a bar at bottom when the page is previewed or saved''</span>
<tt><nowiki>; Header name</nowiki></tt><br />
 
<div style="font-size:0.9em;">''has a leading semicolon'' ";" ''in front''</div>
 
|
 
'''Header name'''<br />
 
<div style="padding: 0.7em .5em; font-size:0.9em;">''will not appear in Table of Contents''</div>
 
  
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|'''Bulleted list'''{{Anchor|Bulleted list}}
 
|
 
<tt>* One</tt><br />
 
<tt>* Two</tt><br />
 
<tt>** Two point one</tt><br />
 
<tt>* Three</tt>
 
|
 
* One
 
* Two
 
** Two point one
 
* Three
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|'''Numbered list'''{{Anchor|Numbered list}}
 
|
 
<tt># One</tt><br />
 
<tt># Two</tt><br />
 
<tt>## Two point one</tt><br />
 
<tt># Three</tt>
 
|
 
# One
 
# Two
 
## Two point one
 
# Three
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|'''Indenting text'''{{Anchor|Indenting text}}
 
<div style="padding: 0.7em .5em; font-size:0.9em;">''this is used when replying on a [[JDOC:Tutorial (Talk pages)|talk page]], to make it easier to follow conversations''</div>
 
|
 
<tt><nowiki>no indent (normal)</nowiki></tt><br />
 
<tt><nowiki>:first indent</nowiki></tt><br />
 
<tt><nowiki>::second indent</nowiki></tt><br />
 
<tt><nowiki>:::third indent</nowiki></tt>
 
|
 
no indent (normal)<br />
 
:first indent
 
::second indent
 
:::third indent
 
 
|}
 
|}
 
</div>
 
</div>
 +
 
<noinclude>
 
<noinclude>
 
 
__NOTOC__ __NOEDITSECTION__
 
__NOTOC__ __NOEDITSECTION__
 
+
[[Category:Documentation Wiki Information|Documentation Wiki Information]]
[[Category:Documentation Wiki Information|{{PAGENAME}}]]
 
 
 
 
</noinclude>
 
</noinclude>

Latest revision as of 08:55, 19 October 2019

Shortcuts:
JDOC:CHEAT
JDOC:EDIT

Joomla Documentation Wiki Cheatsheet

Works only at the beginning of lines    
Description You type You get
Section headings
These are equivalent to using <h2>, <h3>, <h4>, etc.. header tags
</nowiki>a Table of Contents will automatically be generated when four headings are added to an article

==Level 2==
===Level 3===
====Level 4====
=====Level 5=====
======Level 6======

do not use  =Level 1=  as it is for page titles

Level 2

Level 3

Level 4

Level 5
Level 6
Nonindexed headers
left out of Table of Contents

; Header name

has a leading semicolon ";" in front

Header name

will not appear in Table of Contents
Bulleted list
Use the asterisk(*)

* One
* Two
** Two point one
* Three

  • One
  • Two
    • Two point one
  • Three
Numbered list
Use the hash tag(number sign-(#))

# One
# Two
## Two point one
# Three

  1. One
  2. Two
    1. Two point one
  3. Three
Indenting text
this is used when replying on a talk page, to make it easier to follow conversations

no indent (normal)
:first indent
::second indent
:::third indent

no indent (normal)

first indent
second indent
third indent
Works anywhere in the text        
Description You type You get
Italics, bold, and both

''italics'', '''bold''', and '''''both'''''

italics, bold, and both

Link to another page

[[glossary]]
[[glossary]] terms

glossary
glossary terms

"Pipe" a link to change the link's text

[[Administrators|Joomla! Administrator]]

Joomla! Administrator

Link to a section

[[Glossary#Component]]
[[Glossary#Component|Joomla! Component]]

Glossary#Component
Joomla! Component

Red link
red links in articles help by showing desired redirects or Needed pages

[[something missing]]

something missing

References and footnotes
sources in the article will appear where {{reflist}} is put, typically under a level 2 section heading (see below) towards the bottom of the page.

Hello,<ref>Library of Congress</ref> World.<ref>http://www.w3.org/</ref>

References: <references/>

Hello,[1] World.[2]

References:

  1. Library of Congress
  2. http://www.w3.org/
Signature
sign your contributions when posting to a talk page

~~~~

do not sign in an article, only on talk pages

Username (talk) 23:55, 11 May 2024 (UTC)

Display as Code

<tt>JFactory::getApplication()</tt>

JFactory::getApplication()

Plain website link

http://docs.joomla.org

http://docs.joomla.org

Link a website

[http://docs.joomla.org]

[1]

Link and name a website

[http://docs.joomla.org Joomla Documentation Wiki]

Joomla Documentation Wiki

Strike your talk page comment or a list
to show your previous comment is outdated

<s>This topic isn't notable.</s>

This topic isn't notable.

Show an image
for uploading, see the intro to uploading images

[[File:Documentation_all_together_transparent.png|thumb|Caption]]

Caption
Float an image
for uploading, see the intro to uploading images

[[File:Documentation_all_together_transparent.png|left]]

[[File:Documentation_all_together_transparent.png|right]]

Documentation all together transparent.png
Documentation all together transparent.png
Add a page to a category [[Category:Category name{{#translation:}}]]

place near the bottom of a page
shows "Category name" in a bar at bottom when the page is previewed or saved