Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Help:Contents"

From Roll20 Wiki

Jump to: navigation, search
m (Links: expand list of link examples)
m (Categories)
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The Roll20 Wiki is intended to serve as a community resource for help and documentation as well as tips and tricks for best using Roll20 with your tabletop games. We welcome community contributions and would love for you to help us create the best resource we can for your fellow Roll20 users!
+
The '''Roll20 Community Wiki''' is intended to serve as a community resource for help and documentation of the platform, as well as tips and tricks for best using Roll20 with your tabletop games. We welcome community contributions and would love for you to help us create the best resource we can for your fellow Roll20 users! See the [https://roll20.zendesk.com/hc/en-us Roll20 Help Desk] for Official Documentation.
  
Check '''[[:Category:Stubs]]''' and '''[[:Category:NeedsUpdates]]''' for existing pages that need help
+
Check '''[[:Category:Stubs]]''' and '''[[:Category:Tagged for Cleanup]]''' for existing pages that need help.
  
That said, there are a few things we actively discourage at this time:
+
[[File:Roll20Wiki-editor.png|right|thumb|700px|The wiki editor]]
 +
 
 +
==Using the Wiki==
 +
If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia), you can view a lot of helpful information on it [https://meta.wikimedia.org/wiki/Help:Contents here].
 +
 
 +
There are a few things we actively discourage at this time:
  
 
* The wiki is for content that the entire community will find useful. Please don't use it to post information relevant to a specific game/Campaign that you are running.
 
* The wiki is for content that the entire community will find useful. Please don't use it to post information relevant to a specific game/Campaign that you are running.
* The pages in the '''Docs''' Category are only to contain factual information on official Roll20 functionality. These pages are created and maintained only by the Roll20 Staff. Feel free to create additional pages outside that category for workarounds and other non-official tips.
+
* The pages in the '''[[:Category:Docs]]'''-Category are only to contain factual information on official Roll20 functionality. These pages are created and maintained only by the Roll20 Staff. Feel free to create additional pages outside that category using the [[:Category:Guides]], [[:Category:Games]] and [[:Category:Tips]] categories. See  [[Help:Contents#Categories]] for more
* Please do not use wiki pages to lobby for changes to Roll20 features. Instead use the [https://app.roll20.net/forum/category/385189 Suggestions forum]. Talk pages should only be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.
+
* Please do not use wiki pages to lobby for changes to Roll20 features. Instead use the [https://app.roll20.net/forum/category/385189 Suggestions Forum]. Talk pages should only be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.
 
* '''Don't use the wiki to ask questions''', the [https://app.roll20.net/forum/ Forums] are better used for this.
 
* '''Don't use the wiki to ask questions''', the [https://app.roll20.net/forum/ Forums] are better used for this.
  
 
+
===Create New Page===
==Using the Wiki==
+
If you want to create a new, page, use the '''Search''' option and search for the exact name of the page you want to create, and press enter. It now show you a search result of the term, and says '''Create the page "name-of-your-search" on this wiki!''' with a red link, which redirects you to the (non-existing) page, with the option to create it.
 
+
If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia), you can view a lot of helpful information on it [https://meta.wikimedia.org/wiki/Help:Contents here].
+
  
 
==Page formatting ==
 
==Page formatting ==
 
The exists a few tips and tricks how to make pages look better and more readable, here are few main pointers.
 
The exists a few tips and tricks how to make pages look better and more readable, here are few main pointers.
 +
 +
===General===
 +
'''Bold text''': <pre>'''Bold text'''</pre>
 +
 +
''Italic text'': <pre>''Italic text''</pre>
 +
 +
<code>code tag</code> <pre><code>code tag</code></pre>
 +
 +
<pre>text block without formatting</pre>
 +
 +
Use <code><nowiki><pre></nowiki></code> tag to wrap your text to get text block without formatting.
 +
 +
<nowiki>no wiki formatting</nowiki>:
 +
 +
Use <code><nowiki><nowiki></nowiki></code> tag to wrap your text.
 +
 +
extra linebreak: <pre><br></pre>
  
 
===Headings===
 
===Headings===
 
Use headings to structure a page if it contains multiple sections. If a page have enough sections, it will automatically generate a Table of Content. [[Style_Guide_Update|Heading Showcase]]  
 
Use headings to structure a page if it contains multiple sections. If a page have enough sections, it will automatically generate a Table of Content. [[Style_Guide_Update|Heading Showcase]]  
  
===Uploading Images===
+
===Message Boxes===
If you are a new user adding content to the wiki, the option to upload images is disabled by default. If you need to include screenshots or diagrams, contact a Roll20 Developer to enable upload privileges.
+
 
 +
====Standard====
 
<br />
 
<br />
 +
Occasionally, you may want a piece of text take precedence and draw the eye to something very important in the document you're writing. For this instance, use a message box.
 +
{{notebox |notebox template is the simpler alterantive, but less flexible}}
 +
<pre>{{notebox |notebox template is the simpler alterantive, but less flexible}}</pre>
  
===Message Boxes===
+
{{mbox | text = Insert Whatever You Want to Say Here}}
<br />
+
{{mbox | text = '''Note:''' Occasionally, you may want a piece of text take precedence and draw the eye to something very important in the document you're writing. For this instance, use a message box}}
+
 
<br />
 
<br />
 
To add a message box to a wikipage, use this insert:<br />
 
To add a message box to a wikipage, use this insert:<br />
 
<pre>{{mbox | text = Insert Whatever You Want to Say Here}}</pre>
 
<pre>{{mbox | text = Insert Whatever You Want to Say Here}}</pre>
 +
 +
*
 +
====Orange====
 +
{{Ambox
 +
|nocat=true
 +
| type  = content
 +
| text  = This section have sever issues and is likely out of date.
 +
}}
 +
 +
<pre>
 +
{{Ambox
 +
|nocat=true
 +
| type  = content
 +
| text  = This section have sever issues and is likely out of date
 +
}}
 +
</pre>
 +
 +
====Warning====
 +
{{warning|This action is irrecoverable, so proceed with caution }}
 +
 +
<pre>
 +
{{warning|This action is irrecoverable, so proceed with caution }}
 +
</pre>
 +
 +
====Cleanup====
 +
{{cleanup}}
 +
 +
<pre>{{cleanup}}</pre>
 +
 +
{{Ambox
 +
|nocat=true
 +
| type  = style
 +
| text  = This page could do with some cleanup
 +
}}
 +
 +
<pre>
 +
{{Ambox
 +
|nocat=true
 +
| type  = style
 +
| text  = This page could do with some cleanup
 +
}}
 +
</pre>
 +
 +
===Templates===
 +
There are a number of templates that makes things easier, here is a few:
 +
 +
* [[Template:Changelog version]]
 +
* [[Template:User profile]]
 +
* [[Template:Multiple issues]]
 +
* [[Template:Api repository link]]
 +
* [[Template:Ambox/doc]]
 +
 +
For pages describing content limited to Pro users, add the following at the start of the page:
 +
 +
<pre>{{pro only}}</pre>
 +
 +
[[Template:Pro only]]
 +
 +
Display "{{rarr}}" arrow symbol
 +
 +
<pre>{{rarr}}</pre>
  
 
===Collapsible Section===
 
===Collapsible Section===
Line 57: Line 140:
 
<pre>__FORCETOC__</pre>
 
<pre>__FORCETOC__</pre>
  
===Roll20 UI Icons===
+
If you want to move the placement of the TOC on a page, you can place this in the appropriate place:
If you want to display the actual icons used on the Roll20 interface (such as <span style="font-family:Pictos;">y</span>, <span style="font-family:Pictos;">l</span>, <span style="font-family:Pictos;">F</span>, etc.) for clearer instructions in your wiki, you can add a span tag that briefly changes the needed font-family that is used for them.
+
<pre>__TOC__</pre>
  
The font families used for the Roll20 icons are [http://pictos.cc/classic/font Pictos], Pictos Custom, and dicefontd20, and they're available for use within the Roll20 wiki. Going to the font's storefront will give you the character key for the font.  Use this key to identify which character displays which icon.
+
If youdon't want a TOC on the page, place this anywhere on the page:
 +
<pre>__NOTOC__</pre>
  
When you want to add an icon in your wiki, include these HTML snippets, substituting the letter you need for the Pictos or Pictos Custom font family.
+
There is an option for a sideways TOC, useful for A B C sections.
* <span style="font-family:Pictos;">q</span> <code><nowiki><span style="font-family:Pictos;">q</span></nowiki></code> Chat tab
+
 
* <span style="font-family:Pictos;">P</span> <code><nowiki><span style="font-family:Pictos;">P</span></nowiki></code> Art Library tab
+
<pre>{{compact toc}}</pre>
* <span style="font-family:Pictos;">N</span> <code><nowiki><span style="font-family:Pictos;">N</span></nowiki></code> Journal tab
+
 
* <span style="font-family:Pictos Custom;">u</span> <code><nowiki><span style="font-family:Pictos Custom;">u</span></nowiki></code> Jukebox tab
+
* [[Template:Compact_toc/doc]]
* <span style="font-family:Pictos;">l</span> <code><nowiki><span style="font-family:Pictos;">l</span></nowiki></code> Collection tab
+
* <span style="font-family:Pictos;">y</span> <code><nowiki><span style="font-family:Pictos;">y</span></nowiki></code> My Settings tab
+
* <span style="font-family:dicefontd20;">t</span> <code><nowiki><span style="font-family:dicefontd20;">t</span></nowiki></code> d20
+
* <span style="font-family:dicefontd4;">d</span> <code><nowiki><span style="font-family:dicefontd4;">d</span></nowiki></code> d4
+
* <span style="font-family:dicefontd6;">f</span> <code><nowiki><span style="font-family:dicefontd6;">f</span></nowiki></code> d6
+
* <span style="font-family:dicefontd8;">h</span> <code><nowiki><span style="font-family:dicefontd8;">h</span></nowiki></code> d8
+
* <span style="font-family:dicefontd10;">j</span> <code><nowiki><span style="font-family:dicefontd10;">j</span></nowiki></code> d10
+
* <span style="font-family:dicefontd12;">l</span> <code><nowiki><span style="font-family:dicefontd12;">l</span></nowiki></code> d12
+
  
 
=== Displaying Macros and other Code Snippets===
 
=== Displaying Macros and other Code Snippets===
Line 86: Line 162:
 
This looks cleaner (and appears precisely as written) when surrounded by <code>&#60;pre&#62;</code> tags:<br />
 
This looks cleaner (and appears precisely as written) when surrounded by <code>&#60;pre&#62;</code> tags:<br />
 
<pre>/roll 2d5+@{attribute|max}+[[4d4]]</pre>
 
<pre>/roll 2d5+@{attribute|max}+[[4d4]]</pre>
 +
 +
If you use the code tag, you sometime need to wrap the code first in a <code><nowiki><nowiki></nowiki></code>-tag before using <code><nowiki><code></nowiki></code> will look like this:<br />
 +
<code><nowiki>/roll 2d5+@{attribute|max}+[[4d4]]</nowiki></code><br />
  
 
For inline notes and asides you can use <code>&#60;code&#62;</code> tags to embellish things like <code>/roll 3d10</code> or <code>#macroname</code>.
 
For inline notes and asides you can use <code>&#60;code&#62;</code> tags to embellish things like <code>/roll 3d10</code> or <code>#macroname</code>.
  
 
To avoid creating links to non-existing pages when writing inline rolls, use <code><nowiki><pre></nowiki></code> or <code><nowiki><nowiki></nowiki></code> tag.
 
To avoid creating links to non-existing pages when writing inline rolls, use <code><nowiki><pre></nowiki></code> or <code><nowiki><nowiki></nowiki></code> tag.
<nowiki> <nowiki> tag ignores all wiki formatting/templates/linkcreation as can at time be needed together with <code> tag to show some code without problem.</nowiki> <br />'''Click "Edit" for this page to see how the above examples work.'''
+
<code><nowiki><nowiki></nowiki></code> tag ignores all wiki formatting/templates/linkcreation as can at time be needed together with <code><nowiki><code></nowiki></code> tag to show some code without problem.
 +
 
 +
'''Click "Edit" for this page to see how the above examples work.'''
 +
 
 +
===Advanced===
 +
You can use HTML & CSS on the wiki to create some effects that the standard wiki features doesn't. The [[Front Page]] uses several tricks, so it's source code is worth checking out for ideas.
 +
 
 +
==Images & Videos==
 +
 
 +
===Images===
 +
[[File:Roll20 video sm.jpg|thumbnail|250px|right|The image from the wiki frontpage]]
 +
If you are a new user adding content to the wiki, the option to upload images is disabled by default. If you want to be able to upload images, send email to team@roll20.net about it.
 +
<br />
 +
 
 +
Example: image to the right:
 +
<pre>[[File:Roll20 video sm.jpg|thumbnail|250px|right|The image from the wiki frontpage]]</pre>
 +
 
 +
Some tag that can be used:
 +
<pre>thumbnail, thumb, framed, frameless</pre>
 +
 
 +
The <code>thumb</code> tag is the easiest to use, as you can decide the position of the image, and the size of the image can be adjusted. For some of the other tags you can't change the size of the image
 +
 
 +
<br>
 +
<br>
 +
 
 +
===Roll20 UI Icons===
 +
If you want to display the actual icons used on the Roll20 interface (such as <span style="font-family:Pictos;">y</span>, <span style="font-family:Pictos;">l</span>, <span style="font-family:Pictos;">F</span>, etc.) for clearer instructions in your wiki, you can add a span tag that briefly changes the needed font-family that is used for them.
 +
 
 +
The font families used for the Roll20 icons are [http://pictos.cc/classic/font Pictos], Pictos Custom, and dicefontd20, and they're available for use within the Roll20 wiki. Going to the font's storefront will give you the character key for the font.  Use this key to identify which character displays which icon. Check the [[CSS#Icon Fonts|Icon Fonts]] section on the [[CSS Wizardry]] page for a full list of symbols from the fonts.
 +
 
 +
When you want to add an icon in your wiki, include these HTML snippets, substituting the letter you need for the Pictos or Pictos Custom font family.
 +
 
 +
* '''[[Sidebar]]'''
 +
** <span style="font-family:Pictos;">q</span> <code><nowiki><span style="font-family:Pictos;">q</span></nowiki></code> [[Text Chat]] tab
 +
** <span style="font-family:Pictos;">P</span> <code><nowiki><span style="font-family:Pictos;">P</span></nowiki></code> [[Art Library]] tab
 +
** <span style="font-family:Pictos;">N</span> <code><nowiki><span style="font-family:Pictos;">N</span></nowiki></code> [[Journal]] tab
 +
** <span style="font-family:Pictos;">i</span> <code><nowiki><span style="font-family:Pictos;">i</span></nowiki></code> [[Compendium]] tab
 +
** <span style="font-family:Pictos Custom;">u</span> <code><nowiki><span style="font-family:Pictos Custom;">u</span></nowiki></code> [[Jukebox]] tab
 +
** <span style="font-family:Pictos;">l</span> <code><nowiki><span style="font-family:Pictos;">l</span></nowiki></code> [[Collections]] tab
 +
** <span style="font-family:Pictos;">y</span> <code><nowiki><span style="font-family:Pictos;">y</span></nowiki></code> [[My Settings]] tab
 +
 
 +
* '''[[Toolbox]]'''
 +
** <span style="font-family:Pictos Custom;">w</span> <code><nowiki><span style="font-family:Pictos Custom;">w</span></nowiki></code> [[Select and Pan Tool]]
 +
*** [[File:Hand.png|middle|15px]] <code><nowiki>[[File:Hand.png|middle|15px]]</nowiki></code> Pan mode
 +
** <span style="font-family:Pictos;">b</span> <code><nowiki><span style="font-family:Pictos;">b</span></nowiki></code> [[Layers]]
 +
*** <span style="font-family:Pictos;">@</span> <code><nowiki><span style="font-family:Pictos;">@</span></nowiki></code> Map & Background layer
 +
*** <span style="font-family:Pictos;">b</span> <code><nowiki><span style="font-family:Pictos;">b</span></nowiki></code> Objects & Tokens layer
 +
*** <span style="font-family:Pictos;">E</span> <code><nowiki><span style="font-family:Pictos;">E</span></nowiki></code> GM Info Overlay layer
 +
*** <span style="font-family:Pictos Custom;">r</span> <code><nowiki><span style="font-family:Pictos Custom;">r</span></nowiki></code> Dynamic Lighting layer
 +
** <span style="font-family:Pictos Custom;">i</span> <code><nowiki><span style="font-family:Pictos Custom;">i</span></nowiki></code> [[Drawing Tools]]
 +
*** <span style="font-family:Pictos Custom;">a</span> <code><nowiki><span style="font-family:Pictos Custom;">a</span></nowiki></code> Draw Shapes tool
 +
*** <span style="font-family:Pictos Three;">c</span> <code><nowiki><span style="font-family:Pictos Three;">c</span></nowiki></code> Polygon/Line Tool
 +
*** <span style="font-family:Pictos Custom;">q</span>  <code><nowiki><span style="font-family:Pictos Custom;">q</span></nowiki></code>Text Tool
 +
*** <span style="font-family:Pictos;">#</span> <code><nowiki><span style="font-family:Pictos;">#</span></nowiki></code> Clear Drawings tool
 +
** <span style="font-family:Pictos;">e</span> <code><nowiki><span style="font-family:Pictos;">e</span></nowiki></code> [[Custom FX|FX Tool]]
 +
** <span style="font-family:Pictos;">s</span> <code><nowiki><span style="font-family:Pictos;">s</span></nowiki></code> [[Zoom|Zoom Tool]]
 +
** [[File:Ruler.png|middle|15px]] <code><nowiki>[[File:Ruler.png|middle|15px]]</nowiki></code> [[Ruler|Ruler Tool]]
 +
** <span style="font-family:Pictos;">E</span> <code><nowiki><span style="font-family:Pictos;">E</span></nowiki></code> [[Fog of War]]
 +
*** <span style="font-family:Pictos;">E</span> <code><nowiki><span style="font-family:Pictos;">E</span></nowiki></code> Reveal
 +
*** <span style="font-family:Pictos Three;">c</span> <code><nowiki><span style="font-family:Pictos Three;">c</span></nowiki></code> Polygon Reveal
 +
*** <span style="font-family:Pictos;">C</span> <code><nowiki><span style="font-family:Pictos;">C</span></nowiki></code> Hide Areas
 +
*** <span style="font-family:Pictos;">#</span> <code><nowiki><span style="font-family:Pictos;">#</span></nowiki></code> Reset Fog
 +
** <span style="font-family:Pictos;">t</span> <code><nowiki><span style="font-family:Pictos;">t</span></nowiki></code> [[Turn Tracker]]
 +
** <big><span style="font-family:dicefontd20;">t</span></big> <code><nowiki><big><span style="font-family:dicefontd20;">t</span></big></nowiki></code> [[Dice Rolling GUI]]
 +
** <span style="font-family:Pictos;">?</span> <code><nowiki><span style="font-family:Pictos;">?</span></nowiki></code> [[Toolbox_Overview|Help Tool]]
 +
 
 +
'''[[Character Sheet]]'''
 +
* <span style="font-family:Pictos;">&</span> <code><nowiki><span style="font-family:Pictos;">&</span></nowiki></code> Add, repeating section
 +
* <span style="font-family:Pictos;">(</span> <code><nowiki><span style="font-family:Pictos;">(</span></nowiki></code> Lock, repeating section
 +
* <span style="font-family:Pictos;">)</span> <code><nowiki><span style="font-family:Pictos;">)</span></nowiki></code> Unlock, repeating section
 +
* '''<big>≡</big>''' <code><nowiki>'''<big>≡</big>'''</nowiki></code> Reorder symbol, repeating section.
 +
* <span style="font-family:Pictos;">w</span> <code><nowiki><span style="font-family:Pictos;">w</span></nowiki></code> Send to chat
 +
* <span style="font-family:Pictos;">y</span> <code><nowiki><span style="font-family:Pictos;">y</span></nowiki></code> Settings option, gear icon
 +
 
 +
'''Dice'''
 +
* <span style="font-family:dicefontd20;">t</span> <code><nowiki><span style="font-family:dicefontd20;">t</span></nowiki></code> d20
 +
* <span style="font-family:dicefontd4;">d</span> <code><nowiki><span style="font-family:dicefontd4;">d</span></nowiki></code> d4
 +
* <span style="font-family:dicefontd6;">f</span> <code><nowiki><span style="font-family:dicefontd6;">f</span></nowiki></code> d6
 +
* <span style="font-family:dicefontd8;">h</span> <code><nowiki><span style="font-family:dicefontd8;">h</span></nowiki></code> d8
 +
* <span style="font-family:dicefontd10;">j</span> <code><nowiki><span style="font-family:dicefontd10;">j</span></nowiki></code> d10
 +
* <span style="font-family:dicefontd12;">l</span> <code><nowiki><span style="font-family:dicefontd12;">l</span></nowiki></code> d12
 +
 
 +
===Youtube===
 +
You can have an embedded video on a page.
 +
 
 +
{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}
 +
 
 +
This can be achieved with:
 +
 
 +
<code><nowiki>{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}</nowiki></code>
  
 
==Structure==
 
==Structure==
 
A few things makes the wiki easier to use and easier to find related pages.
 
A few things makes the wiki easier to use and easier to find related pages.
  
===Categories===
+
===Links===
A categorized page is easier to find, so please add at least one relevant category to any new page you create. There are few of the main wiki categories:
+
If an article mentions things that have a wiki page, it's useful to link to that  page the first time it's mentioned. For example, there exists several [[Star Wars RPG|Star Wars RPGs]] and some of them have guides on the wiki. Sometimes links outside the wiki is also useful.
  
====Content====
+
====External Link====
* '''[[:Category:Games]]''': For thorough run-through of how to play a particular tRPG system in Roll20
+
If you want to link to a page outside the wiki, you need to use single brackets.
** '''[[:Category:Character Sheet Documentation]]''' For guides dedicated to specific character sheets
+
* '''[[:Category:Guides]]''': Many pages under the Games category fall in here too; anything extensively explained should use this category
+
* '''[[:Category:Tips]]''': For smaller pages that cover a portion of the Roll20 platform (I.e. tips and tricks)
+
* '''[[:Category:Macros]]''' For pages largely dedicated to Roll20 macros
+
* '''[[:Category:Marketplace]]''': This Category are for creators regarding their content placed on the Roll20 Marketplace
+
* [[Special:Categories|Full list of existing categories]]
+
  
====Wiki Administration====
+
Example: [https://app.roll20.net/forum/ Roll20 Forums]
* '''[[:Category:NeedsUpdates]]''' for outdated or half-done pages
+
* '''[[:Category:Stubs]]''' for short articles that could use more content
+
* '''[[:Category:Articles for deletion]]''' page that is clearly
+
  
To add a category to a page, simply add this line of text at the very bottom:
+
<pre>[https://app.roll20.net/forum/ Roll20 Forums]</pre>
<pre>[[Category:Category Name]]</pre>
+
If the page falls under multiple categories, add another category tag underneath first and so forth (don't combine them in one tag).
+
<br />
+
  
===Links===
+
====Wiki Page====
If an article mentions things that have a wiki page, it's useful to link to that  page the first time it's mentioned. For example, there exists several [[Star Wars RPG|Star Wars RPGs]] and some of them have guides on the wiki. SOmetimes links outside the wiki is also useful.
+
  
 
'''Example:'''
 
'''Example:'''
Line 127: Line 282:
 
Link to the wiki's [[Main_Page|front page]], with a custom link name.
 
Link to the wiki's [[Main_Page|front page]], with a custom link name.
 
<pre>[[Main_Page|front page]]</pre>
 
<pre>[[Main_Page|front page]]</pre>
 
Hyperlinks that [https://meta.wikimedia.org/wiki/Help:Wikitext_examples|leads outside the wiki]:
 
<pre>[https://meta.wikimedia.org/wiki/Help:Wikitext_examples|leads outside the wiki]</pre>
 
  
 
Link a subsection of an article. For example you might need to mentioning there are [[Compendium_Sharing#What_are_the_Limitations_of_Compendium_Sharing.3F|limits to compendium sharing]]. You can find the exact name of an sub-section, by copying the link from the ToC.
 
Link a subsection of an article. For example you might need to mentioning there are [[Compendium_Sharing#What_are_the_Limitations_of_Compendium_Sharing.3F|limits to compendium sharing]]. You can find the exact name of an sub-section, by copying the link from the ToC.
 
<pre>[[Compendium_Sharing#What_are_the_Limitations_of_Compendium_Sharing.3F|limits to compendium sharing]]</pre>
 
<pre>[[Compendium_Sharing#What_are_the_Limitations_of_Compendium_Sharing.3F|limits to compendium sharing]]</pre>
  
 +
=====Main Article=====
 +
 +
{{main|Journal}}
 +
 +
<pre>{{main|Journal}}</pre>
 +
 +
====Wiki Category====
 
Link to a Category page. It can be useful to link to a category page, such as all user-created [[:Category:Tips]]. You need to place a ':' in front of the page name, like:
 
Link to a Category page. It can be useful to link to a category page, such as all user-created [[:Category:Tips]]. You need to place a ':' in front of the page name, like:
 
<pre>[[:Category:Tips]]</pre>
 
<pre>[[:Category:Tips]]</pre>
  
==='See Also' section===
+
====Roll20 User====
Sometimes it's useful to have a section at the end of an articles dedicated to a list of relevant other articles or links elsewhere. A character sheet guide could have a GitHub link to the sheet's source code, or [[Geomorphic Map Tiles#See Also|article on making maps]] could link to other map-related wiki pages.
+
You can also link directly to a Roll20 user's profile for the wiki, instead of typing the full url. The second method doesn't show the symbol for the link going outside Roll20.
 +
 
 +
<pre>[https://app.roll20.net/users/4/ Roll20 Dev Team]</pre>
 +
<pre>{{user profile|4|Roll20 Dev Team}}</pre>
 +
 
 +
===Categories===
 +
A categorized page is easier to find, so please add at least one relevant category to any new page you create. There are few of the main wiki categories:
 +
 
 +
To add a category to a page, simply add this line of text at the very bottom:
 +
<pre>[[Category:Category Name]]</pre>
 +
If the page falls under multiple categories, add another category tag underneath first and so forth (don't combine them in one tag).
 +
 
 +
====Content====
 +
* '''[[:Category:Games]]''': For articles of how to play a particular TTRPG system in Roll20. If a system have several pages like this, it can be a good idea to only categorize the "main" one with "Games" and link the other page to the main one.
 +
** '''[[:Category:Character Sheet Documentation]]''' For guides dedicated to specific character sheets
 +
** '''Popular Systems''' If a Game System or Other franchise starts to have lots of pages, it can be a good idea to have a category for them so they are easier to connect and find, and only givve the "main" article the '''[[:Category:Games]]'''-category
 +
*** '''[[:Category:DnD5E]]''' for [[5E|Dungeons & Dragons 5E]] pages
 +
*** '''[[:Category:DnD]]''' for any other [[DnD|Dungeons & Dragons]] pages
 +
*** '''[[:Category:Star Wars]]''' for the various systems of homebrew based on Star Wars franchise
 +
*** '''[[:Category:Pathfinder]]''' for both 1E and 2E pages, Starfinder could be bundled in, or given own category if it gets many pages
 +
*** '''[[:Category:Fate]]''' For both [[Fate]] Core & Fate Accelerated pages
 +
*** '''[[:Category:WoD]]'''' For all [[World of Darkness]] related pages
 +
* '''[[:Category:Guides]]''': Many pages under the Games category fall in here too; anything extensively explained should use this category
 +
* '''[[:Category:Tips]]''': For smaller pages that cover a portion of the Roll20 platform (I.e. tips and tricks), or a collection of less organized Tips
 +
* '''[[:Category:Macros]]''' For pages largely dedicated to Roll20 macros
 +
* '''[[:Category:Character Sheet Creation]]''' Pages that help with [[Building Character Sheets]]
 +
** '''[[:Category:Sheetworker]]''' Pages on creating [[Sheetworkers]] for character sheets.
 +
* '''[[:Category:Marketplace]]''': This Category are for creators regarding their content placed on the Roll20 Marketplace
 +
* [[Special:Categories|Full list of existing categories]]
 +
 
 +
====Wiki Administration====
 +
* '''[[:Category:NeedsUpdates]]''' for outdated or half-done pages
 +
* '''[[:Category:Stubs]]''' for short articles that could use more content
 +
* '''[[:Category:Articles for deletion]]''' page that is clearly
 +
* '''[[:Category:Language-FR]]''' and '''[[:Category:Language-DE]]''' for french and german wiki
 +
<br />
 +
 
 +
==='See Also' or 'Related Pages' section===
 +
Sometimes it's useful to have a section at the end of a page dedicated to a list of relevant other pages or links elsewhere. A character sheet guide could have a GitHub link to the sheet's source code, or [[Geomorphic Map Tiles#See Also|pages on making maps]] could link to other map-related wiki pages. [[Toolbox Overview]] is a good example of a page listing higly related pages
  
 
==See also==
 
==See also==

Revision as of 15:11, 26 May 2020

The Roll20 Community Wiki is intended to serve as a community resource for help and documentation of the platform, as well as tips and tricks for best using Roll20 with your tabletop games. We welcome community contributions and would love for you to help us create the best resource we can for your fellow Roll20 users! See the Roll20 Help Desk for Official Documentation.

Check Category:Stubs and Category:Tagged for Cleanup for existing pages that need help.

The wiki editor

Contents

Using the Wiki

If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia), you can view a lot of helpful information on it here.

There are a few things we actively discourage at this time:

  • The wiki is for content that the entire community will find useful. Please don't use it to post information relevant to a specific game/Campaign that you are running.
  • The pages in the Category:Docs-Category are only to contain factual information on official Roll20 functionality. These pages are created and maintained only by the Roll20 Staff. Feel free to create additional pages outside that category using the Category:Guides, Category:Games and Category:Tips categories. See Help:Contents#Categories for more
  • Please do not use wiki pages to lobby for changes to Roll20 features. Instead use the Suggestions Forum. Talk pages should only be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.
  • Don't use the wiki to ask questions, the Forums are better used for this.

Create New Page

If you want to create a new, page, use the Search option and search for the exact name of the page you want to create, and press enter. It now show you a search result of the term, and says Create the page "name-of-your-search" on this wiki! with a red link, which redirects you to the (non-existing) page, with the option to create it.

Page formatting

The exists a few tips and tricks how to make pages look better and more readable, here are few main pointers.

General

Bold text:
'''Bold text'''
Italic text:
''Italic text''
code tag
<code>code tag</code>
text block without formatting

Use <pre> tag to wrap your text to get text block without formatting.

no wiki formatting:

Use <nowiki> tag to wrap your text.

extra linebreak:
<br>

Headings

Use headings to structure a page if it contains multiple sections. If a page have enough sections, it will automatically generate a Table of Content. Heading Showcase

Message Boxes

Standard


Occasionally, you may want a piece of text take precedence and draw the eye to something very important in the document you're writing. For this instance, use a message box.

{{notebox |notebox template is the simpler alterantive, but less flexible}}


To add a message box to a wikipage, use this insert:

{{mbox | text = Insert Whatever You Want to Say Here}}

Orange

{{Ambox
|nocat=true
| type  = content
| text  = This section have sever issues and is likely out of date
}}

Warning


{{warning|This action is irrecoverable, so proceed with caution }}

Cleanup


{{cleanup}}
{{Ambox
|nocat=true
| type  = style
| text  = This page could do with some cleanup
}}

Templates

There are a number of templates that makes things easier, here is a few:

For pages describing content limited to Pro users, add the following at the start of the page:

{{pro only}}

Template:Pro only

Display "→" arrow symbol

{{rarr}}

Collapsible Section

Example of a collapsable section
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse eget nunc id felis maximus ullamcorper. Quisque felis odio, commodo vitae lorem et, sagittis dictum mauris. Ut eu nibh et dolor vehicula gravida sit amet et sapien.

Sed vel ullamcorper arcu, non ultrices tortor. Vestibulum massa risus, varius eget molestie in, posuere quis massa. Mauris sit amet ligula lorem. Sed pulvinar dapibus urna, et pellentesque quam commodo et.

Code for the collapsible section example:

{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| Example of a collapsable section
|-
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse eget nunc id felis maximus ullamcorper. Quisque felis odio, commodo vitae lorem et, sagittis dictum mauris. Ut eu nibh et dolor vehicula gravida sit amet et sapien.

Sed vel ullamcorper arcu, non ultrices tortor. Vestibulum massa risus, varius eget molestie in, posuere quis massa. Mauris sit amet ligula lorem. Sed pulvinar dapibus urna, et pellentesque quam commodo et.
|}

Table of Content

If you have 4 or more Headings, the page will automatically show a Table of Content(TOC) at the top of the page. You can force to have display it if you have fewer heading with adding this to the sheet:

__FORCETOC__

If you want to move the placement of the TOC on a page, you can place this in the appropriate place:

__TOC__

If youdon't want a TOC on the page, place this anywhere on the page:

__NOTOC__

There is an option for a sideways TOC, useful for A B C sections.

{{compact toc}}

Displaying Macros and other Code Snippets

If you want to share Macros, complicated dice rolls, or CSS and HTML code, it might be a good idea to put your examples inside <pre> tags.

A messy example:
/roll 2d5+@{attribute|max}+4d4
The 4d4 here is supposed to be surrounded by square brackets, but they disappear if they're left naked to WikiMedia's markup conventions. Worse still, in this case, markup attempts to link it to non-existent page called "4d4".

This looks cleaner (and appears precisely as written) when surrounded by <pre> tags:

/roll 2d5+@{attribute|max}+[[4d4]]

If you use the code tag, you sometime need to wrap the code first in a <nowiki>-tag before using <code> will look like this:
/roll 2d5+@{attribute|max}+[[4d4]]

For inline notes and asides you can use <code> tags to embellish things like /roll 3d10 or #macroname.

To avoid creating links to non-existing pages when writing inline rolls, use <pre> or <nowiki> tag. <nowiki> tag ignores all wiki formatting/templates/linkcreation as can at time be needed together with <code> tag to show some code without problem.

Click "Edit" for this page to see how the above examples work.

Advanced

You can use HTML & CSS on the wiki to create some effects that the standard wiki features doesn't. The Front Page uses several tricks, so it's source code is worth checking out for ideas.

Images & Videos

Images

The image from the wiki frontpage

If you are a new user adding content to the wiki, the option to upload images is disabled by default. If you want to be able to upload images, send email to team@roll20.net about it.

Example: image to the right:

[[File:Roll20 video sm.jpg|thumbnail|250px|right|The image from the wiki frontpage]]

Some tag that can be used:

thumbnail, thumb, framed, frameless

The thumb tag is the easiest to use, as you can decide the position of the image, and the size of the image can be adjusted. For some of the other tags you can't change the size of the image



Roll20 UI Icons

If you want to display the actual icons used on the Roll20 interface (such as y, l, F, etc.) for clearer instructions in your wiki, you can add a span tag that briefly changes the needed font-family that is used for them.

The font families used for the Roll20 icons are Pictos, Pictos Custom, and dicefontd20, and they're available for use within the Roll20 wiki. Going to the font's storefront will give you the character key for the font. Use this key to identify which character displays which icon. Check the Icon Fonts section on the CSS Wizardry page for a full list of symbols from the fonts.

When you want to add an icon in your wiki, include these HTML snippets, substituting the letter you need for the Pictos or Pictos Custom font family.

  • Sidebar
    • q <span style="font-family:Pictos;">q</span> Text Chat tab
    • P <span style="font-family:Pictos;">P</span> Art Library tab
    • N <span style="font-family:Pictos;">N</span> Journal tab
    • i <span style="font-family:Pictos;">i</span> Compendium tab
    • u <span style="font-family:Pictos Custom;">u</span> Jukebox tab
    • l <span style="font-family:Pictos;">l</span> Collections tab
    • y <span style="font-family:Pictos;">y</span> My Settings tab
  • Toolbox
    • w <span style="font-family:Pictos Custom;">w</span> Select and Pan Tool
      • Hand.png [[File:Hand.png|middle|15px]] Pan mode
    • b <span style="font-family:Pictos;">b</span> Layers
      • @ <span style="font-family:Pictos;">@</span> Map & Background layer
      • b <span style="font-family:Pictos;">b</span> Objects & Tokens layer
      • E <span style="font-family:Pictos;">E</span> GM Info Overlay layer
      • r <span style="font-family:Pictos Custom;">r</span> Dynamic Lighting layer
    • i <span style="font-family:Pictos Custom;">i</span> Drawing Tools
      • a <span style="font-family:Pictos Custom;">a</span> Draw Shapes tool
      • c <span style="font-family:Pictos Three;">c</span> Polygon/Line Tool
      • q <span style="font-family:Pictos Custom;">q</span>Text Tool
      • # <span style="font-family:Pictos;">#</span> Clear Drawings tool
    • e <span style="font-family:Pictos;">e</span> FX Tool
    • s <span style="font-family:Pictos;">s</span> Zoom Tool
    • Ruler.png [[File:Ruler.png|middle|15px]] Ruler Tool
    • E <span style="font-family:Pictos;">E</span> Fog of War
      • E <span style="font-family:Pictos;">E</span> Reveal
      • c <span style="font-family:Pictos Three;">c</span> Polygon Reveal
      • C <span style="font-family:Pictos;">C</span> Hide Areas
      • # <span style="font-family:Pictos;">#</span> Reset Fog
    • t <span style="font-family:Pictos;">t</span> Turn Tracker
    • t <big><span style="font-family:dicefontd20;">t</span></big> Dice Rolling GUI
    • ? <span style="font-family:Pictos;">?</span> Help Tool

Character Sheet

  • & <span style="font-family:Pictos;">&</span> Add, repeating section
  • ( <span style="font-family:Pictos;">(</span> Lock, repeating section
  • ) <span style="font-family:Pictos;">)</span> Unlock, repeating section
  • '''<big>≡</big>''' Reorder symbol, repeating section.
  • w <span style="font-family:Pictos;">w</span> Send to chat
  • y <span style="font-family:Pictos;">y</span> Settings option, gear icon

Dice

  • t <span style="font-family:dicefontd20;">t</span> d20
  • d <span style="font-family:dicefontd4;">d</span> d4
  • f <span style="font-family:dicefontd6;">f</span> d6
  • h <span style="font-family:dicefontd8;">h</span> d8
  • j <span style="font-family:dicefontd10;">j</span> d10
  • l <span style="font-family:dicefontd12;">l</span> d12

Youtube

You can have an embedded video on a page.

Tutorial for the Drawing Tools

This can be achieved with:

{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}

Structure

A few things makes the wiki easier to use and easier to find related pages.

Links

If an article mentions things that have a wiki page, it's useful to link to that page the first time it's mentioned. For example, there exists several Star Wars RPGs and some of them have guides on the wiki. Sometimes links outside the wiki is also useful.

External Link

If you want to link to a page outside the wiki, you need to use single brackets.

Example: Roll20 Forums

[https://app.roll20.net/forum/ Roll20 Forums]

Wiki Page

Example:

Simple link to Journal wiki page:

[[Journal]]

Link to the wiki's front page, with a custom link name.

[[Main_Page|front page]]

Link a subsection of an article. For example you might need to mentioning there are limits to compendium sharing. You can find the exact name of an sub-section, by copying the link from the ToC.

[[Compendium_Sharing#What_are_the_Limitations_of_Compendium_Sharing.3F|limits to compendium sharing]]
Main Article

Main Page: Journal

{{main|Journal}}

Wiki Category

Link to a Category page. It can be useful to link to a category page, such as all user-created Category:Tips. You need to place a ':' in front of the page name, like:

[[:Category:Tips]]

Roll20 User

You can also link directly to a Roll20 user's profile for the wiki, instead of typing the full url. The second method doesn't show the symbol for the link going outside Roll20.

[https://app.roll20.net/users/4/ Roll20 Dev Team]
{{user profile|4|Roll20 Dev Team}}

Categories

A categorized page is easier to find, so please add at least one relevant category to any new page you create. There are few of the main wiki categories:

To add a category to a page, simply add this line of text at the very bottom:

[[Category:Category Name]]

If the page falls under multiple categories, add another category tag underneath first and so forth (don't combine them in one tag).

Content

Wiki Administration


'See Also' or 'Related Pages' section

Sometimes it's useful to have a section at the end of a page dedicated to a list of relevant other pages or links elsewhere. A character sheet guide could have a GitHub link to the sheet's source code, or pages on making maps could link to other map-related wiki pages. Toolbox Overview is a good example of a page listing higly related pages

See also