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 (Templates)
m
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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.
+
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!
  
Check '''[[:Category:Stubs]]''' and '''[[:Category:NeedsUpdates]]''' for existing pages that need help
+
'''See the {{hc| Roll20 Help Center}} for Official Documentation.'''(that may or may not have more/better info than the Community Wiki) If the Official documentation have errors/mistakes, remember to {{bug}}. 
 +
 
 +
Check '''[[:Category:Stubs]]''' and '''[[:Category:Tagged for Cleanup]]''' for pages that can really need help with updating.
  
 
[[File:Roll20Wiki-editor.png|right|thumb|700px|The wiki editor]]
 
[[File:Roll20Wiki-editor.png|right|thumb|700px|The wiki editor]]
  
==Using the Wiki==
+
==Contributing to 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].
+
If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia and Fandom Wikia), you can view a lot of helpful information on it [https://meta.wikimedia.org/wiki/Help:Contents here]. The Roll20 Community Wiki runs on a somewhat older version of MediaWiki, so some newer features used elsewhere aren't avaiable, but at the core functions like other Wikis created with MediaWiki.
 +
 
 +
'''Wiki Purpose & Suggestions on what to add'''
 +
 
 +
Some ideas on what is a good fit for the Roll20 Community Wiki:
 +
 
 +
# '''Content that the entire community will find useful.''' Guides, Tips & tricks for variety of Roll20-related features, suggestions on how to implement certain elements in a game, pages with resources and links to relevant forum posts, pages on other sites, or video tutorials.
 +
# '''Info & tips on playing a specific game  on Roll20.''' Pages like [[Star Wars D6]], [[WoD]] & [[Pathfinder]] contains various tips on how to play the games, and can serve as a hub with links to other relevant pages.
 +
# '''Info & tips on how to use a specific character sheet.''' Roll20 have hundreds of community-contributed sheets & a handful of official sheets, of which only few have any extra info on how to use them, and all works slightly differently. [https://roll20.zendesk.com/hc/en-us/categories/360003712814-Roll20-Character-Sheets All Official Character Sheets don't have documentation pages on the Help Center], and even when they do, the page might lack some info, so creating/updating the [[:Category:Official_Sheet|Community Wiki's version of the page]] could be a good idea. Sometimes even creating a short wiki page addressing a common issue with a sheet will make it easier for other to figure it out.
 +
# '''If the Official [https://roll20.zendesk.com/hc/en-us Roll20 Help Desk] is lacking Documentation for some feature, is confusing or too short, have errors, it can be a good idea to update the Community Wiki's page for the same topic.''' If a page for it doesn't exist, one can be created, and featuring the clarification to the feature, along with a link to the Helpdesk article. You could also copy the full article to the wiki, and then expand/edit it to your liking.
 +
# '''Linking great forum posts on pages related to a topic/feature.''' If good advice on a topic exist on a number of forum threads, it can be enough to just create a new wiki page for the topic and give a list of links to the threads, instead of writing a full-blown article on it. Having a wiki page for a topic makes the info more accessible/findable, even if it just links to a couple of forum posts.
  
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 [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.
 
  
 
===Create New Page===
 
===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.
 
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.
 +
 +
Try give it a sensible & and shorter name if possible, then the page is more likely to be found when using the wiki's search. You can also create redirects to a page if you think it might be harder to find.
 +
 +
* Example: [[5E]](wiki.roll20.net/5E) is the page displaying info related to D&D 5E, the most popular game on the platform, so makes sense to have a short and simple url.
 +
* Another example: the [[Linking Tokens to Journals]] page has [[Link Token]] as a redirect page, making the popular page easier to find, and even possible to remember the url itself.
 +
 +
Redirect page: create the new page, and add <code><nowiki>#REDIRECT [[name of the page it should link to]]</nowiki></code>, then save it. no the new page redirect to the page you wanted. Example: <code><nowiki>#REDIRECT [[Help:Contents]]</nowiki></code> would redirect a page here.
 +
 +
===Updating/Expanding the Wiki===
 +
Few thing to consider:
 +
 +
# After creating a new page, it's a good idea to add links to it on existing pages where it's relevant. If there is no links/mentions of a page, it's less likely to be found.
 +
# If there is a good forum post or other place it relevant info, adding a link to the wiki page is a good idea.
 +
# Add images if possible. by default users don't have image upload access, but you can submit a [https://roll20.zendesk.com/hc/en-us/requests/new Helpdesk ticket] for it, mentioning your user ID, and why you want image upload access.
 +
# If someone show you an undocumented feature/quirk of Roll20, it would be a good idea to mention it on the relevant wiki page.
 +
# If a wiki page starts to become very long, it might be a good idea to split of a large section that is self-contained and likely to become larger to it's own page, and then link to the full page on the original section, while reducing the text on the original page. Alternatively, you could put parts of the section in a [[#Collapsible Section|Collapsible Section]].
 +
# The pages in the '''[[:Category:Docs]]'''-Category are only to contain factual information on official Roll20 functionality or distinct features. These pages where originally created by the Roll20 Staff, but now that the wiki have turned into a Community Wiki, we can categorize new pages under it. Feel free to create additional pages outside that category using the [[:Category:Guides]], [[:Category:Games]] and [[:Category:Tips]] categories, or create subcategories when needed. See  [[Help:Contents#Categories]] for longer list of existing categories.
 +
 +
===Please don't===
 +
 +
# Please don't use the wiki to post information relevant to specific games/Campaigns that you are running.
 +
# Please don't use the wiki pages to lobby for changes to Roll20(doesn't have much reach anyway). Instead post to the Official [https://app.roll20.net/forum/category/385189 Suggestions Forum] or vote/comment on existing suggestions. Wiki Talk pages should 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 about how Roll20 works''', the [https://app.roll20.net/forum/ Forums] are better used for this. Basically nobody sees random new wiki, pages or if there are any talk pages, so it's pointless anyway.
  
 
==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.
+
A few tips and tricks can help make pages look better and more readable; here are a few main pointers.
 +
 
 +
You can check the [[sandbox]] page for some often useful code snippets, and you can create your own sandbox to test/play around in, by going to your own wiki page(link in the sidebar), and then adding <code>/sandbox</code> to the end of the url. hten you'll have a personal test page under your own profile without having to worry about testing if you want to do some large/wild edits.
  
 
===General===
 
===General===
Line 25: Line 57:
  
 
''Italic text'': <pre>''Italic text''</pre>
 
''Italic text'': <pre>''Italic text''</pre>
 +
 +
<strike>Strikeout text</strike>: <pre><strike>Strikeout text</strike></pre>
  
 
<code>code tag</code> <pre><code>code tag</code></pre>
 
<code>code tag</code> <pre><code>code tag</code></pre>
Line 39: Line 73:
  
 
===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.  
  
===Message Boxes===
+
See '''[[Style_Guide_Update|Heading Showcase]]''' for more info.
  
 +
<pre>
 +
=Top Header=
 +
The above creates the largest possible section heading, making the text blue
 +
 +
==Second Tier==
 +
The above creates the second-largest possible section heading, with a black text. Subsequent headings are smaller and black.
 +
 +
Somwhere around Headings 5, the title tarts to become so small that it's hard to notice from the general text of an article, and normal, bold text pops out more.
 +
 +
Depending on how things look, the foollowing can be a good idea:
 +
 +
====='''manually bolded headings'''=====
 +
</pre>
 +
 +
===Message Boxes===
 +
There are a number of different message boxes that can be used on the wiki, and here are shown the most useful ones.
 
====Standard====
 
====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.
 
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 alternative, but less flexible}}
 +
<pre>{{notebox|notebox template is the simpler alternative, but less flexible}}</pre>
 +
 
{{mbox | text = Insert Whatever You Want to Say Here}}
 
{{mbox | text = Insert Whatever You Want to Say Here}}
 
<br />
 
<br />
Line 51: Line 104:
 
<pre>{{mbox | text = Insert Whatever You Want to Say Here}}</pre>
 
<pre>{{mbox | text = Insert Whatever You Want to Say Here}}</pre>
  
*
 
 
====Orange====
 
====Orange====
{{Ambox
+
{{orange| This section have sever issues and is likely out of date}}
|nocat=true
+
| type  = content
+
| text  = This section have sever issues and is likely out of date.
+
}}
+
 
+
 
<pre>
 
<pre>
{{Ambox
+
{{orange| This section have sever issues and is likely out of date}}
|nocat=true
+
| type  = content
+
| text  = This section have sever issues and is likely out of date
+
}}
+
 
</pre>
 
</pre>
 +
 +
The [[Template:Orange]] can be used to highlight some semi-important thing, if you don't want to use the  much stronger/dire [[Template:Warning]] with it's sign, or if the blue [[Template:Notebox]] infobox doesn't convey enough urgency.
  
 
====Warning====
 
====Warning====
{{Ambox
+
{{warning|This action is irrecoverable, so proceed with caution }}
|nocat=true
+
| type  = delete
+
| text  = This action is irrecoverable, so proceed with caution  
+
}}
+
  
 
<pre>
 
<pre>
{{Ambox
+
{{warning|This action is irrecoverable, so proceed with caution }}
|nocat=true
+
| type  = delete
+
| text  = This action is irrecoverable, so proceed with caution  
+
}}
+
 
</pre>
 
</pre>
  
Line 85: Line 122:
 
{{cleanup}}
 
{{cleanup}}
  
<pre>{{cleanup}}</pre>
+
{{tlx|cleanup}}
  
 
{{Ambox
 
{{Ambox
 
|nocat=true
 
|nocat=true
 
| type  = style
 
| type  = style
| text  = This page could do with some cleanup
+
| text  = This page could do with some cleanup [[User:1223200|1223200]] ([[User talk:1223200|talk]]) 13:37, 25 September 2020 (UTC)
 
}}
 
}}
  
Line 97: Line 134:
 
|nocat=true
 
|nocat=true
 
| type  = style
 
| type  = style
| text  = This page could do with some cleanup
+
| text  = This page could do with some cleanup ~~~~
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
It can be a good idea to quickly sign off your name & the date by using <code><nowiki>~~~~</nowiki></code>, which will add your name & the date quickly. That will help other to know how long the section have been in need of cleanup.
 +
 +
====Other====
 +
{{POV}}
 +
 +
{{tlx|POV}}
  
 
===Templates===
 
===Templates===
There are a number of templates that makes things easier, here is a few:
+
There are a number of [https://www.mediawiki.org/wiki/Help:Templates wiki templates] that makes a number of things easier, here are a few of them. Most other templates are showcased in more specific sections of this page, such as image-related under Images.
  
* [[Template:Changelog version]]
+
* {{tlx|Changelog version]] - usedful for creating API script or Character Sheet Changelogs
* [[Template:User profile]]
+
* {{tlx|User profile]]
* [[Template:Multiple issues]]
+
* {{tlx|Multiple issues]]
* [[Template:Api repository link]]
+
* {{tlx|repo}} - links to github code
* [[Template:Ambox/doc]]
+
* [[Template:Ambox/doc]] - the core template used for making the several info & notice boxes
 +
* {{tlx|Mbox}} - meta-template is used to build message box
 +
* {{tlx|tlx}} - meta-template used for linking to the template's page and might display how it should be used.
  
 
For pages describing content limited to Pro users, add the following at the start of the page:
 
For pages describing content limited to Pro users, add the following at the start of the page:
Line 114: Line 160:
 
<pre>{{pro only}}</pre>
 
<pre>{{pro only}}</pre>
  
[[Template:Pro only]]
+
{{tlx|pro only}}
  
 
Display "{{rarr}}" arrow symbol
 
Display "{{rarr}}" arrow symbol
Line 130: Line 176:
 
|}
 
|}
  
Code for the collapsible section example:
+
Code for the collapsible section, where having <code>mw-collapsed</code> will make it collapsed by default:
 
<pre>
 
<pre>
 
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
 
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
Line 153: Line 199:
 
There is an option for a sideways TOC, useful for A B C sections.
 
There is an option for a sideways TOC, useful for A B C sections.
  
<pre>{{compact toc}</pre>
+
<pre>{{compact toc}}</pre>
  
 
* [[Template:Compact_toc/doc]]
 
* [[Template:Compact_toc/doc]]
  
=== Displaying Macros and other Code Snippets===
+
You can also make the TOC appear on the right side of the page with:
  
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 <code>&#60;pre&#62;</code> tags.
+
<pre>{{tocright}}</pre>
  
A messy example:<br />
+
=== Displaying Macros and Code===
''/roll 2d5+@{attribute|max}+[[4d4]]''<br />
+
If you add HTML code, or other code/macros to a wiki without precautions, the wiki will misunderstand is as MediaWiki code, and change how the page/text looks, instead of showing the raw code.
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 <code>&#60;pre&#62;</code> tags:<br />
+
For showing short code snippets in flowing text, using the <code>&#60;code&#62;</code> element is a good idea(and sometimes adding <code>&#60;nowiki&#62;</code> inside it), but if you want to show a block of code with several rows, use the <code>&#60;pre&#62;</code>-element instead. [[Roll Template]] code is always tricky to show, so it should always be either inside a <code>&#60;pre&#62;</code>-element, or shown using <code>&#60;code&#62;</code> + <code>&#60;nowiki&#62;</code>.
<pre>/roll 2d5+@{attribute|max}+[[4d4]]</pre>
+
 
 +
For really tricky sections, you might want to try using [https://www.freeformatter.com/html-entities.html HTML entities](replacement code) to replace some character, so that the character is shown on the page, but the wiki doesn't try to read it as if it's part of some code. This section contains a few examples of this(press ''Edit'' to see the code).
 +
 
 +
'''Examples to copy:'''
 +
<pre>
 +
<code>&#60;nowiki&#62;/r 2d5+@{attribute|max}+[[4d4]]&#60;/nowiki&#62;</code>
 +
&#60;pre style="overflow:scroll;margin-bottom: 5px;" data-language="html"&#62; &#60;/pre&#62;
 +
</pre>
 +
 
 +
'''Macro without formatting'''
 +
 
 +
A messy example:<br /><br />
 +
''/r 2d5+@{attribute|max}+[[4d4]] damage''
 +
<br /><br />
 +
 
 +
The macro code is just highlighted in italics using the Wiki formatting, and doesn't look good. 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".
 +
 
 +
'''Macro using <code>&#60;code&#62;</code> & <code>&#60;nowiki&#62;</code>'''
 +
 
 +
<code><nowiki>/r 2d5+@{attribute|max}+[[4d4]]</nowiki></code>
  
 
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 />
 
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 />
+
<code><nowiki>/r 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.
<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.
+
<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  
 +
 
 +
'''Macro using <code>&#60;pre&#62;</code>'''
 +
 
 +
When surrounded by <code>&#60;pre&#62;</code> element, the macro is displayed in a separate code block, and not in the flowing text. Adding some CSS to make sure the code remains readable is a good idea, such as <code>style="overflow:scroll;"</code><br />
 +
 
 +
<pre style="overflow:scroll;margin-bottom: 5px;">/em attacks for 2d5+@{attribute|max}+[[4d4]]</pre>
 +
 
 +
The above code is shown nice anc clean, without the wiki trying to do it's tricks.
 +
 
 +
Here is the wiki code for making a good & quick the pre element:
 +
<pre>
 +
&#60;pre style="overflow:scroll;margin-bottom: 5px;" data-language="html"&#62; &#60;/pre&#62;
 +
</pre>
 +
 
 +
'''Displaying HTML/CSS/Javascript code with syntax highlights'''
 +
 
 +
For displaying blocks of code like HTML/CSS/JavaScript on the wiki(like in the context of Character Sheet or API code), it's best to use the <code>&#60;pre&#62;</code> element, and additionally style the section with <code>style="overflow:scroll;"</code>, and to add syntax highlight to make the code more readable with <code>data-language="html/css/javascript"</code>
 +
 
 +
<pre style="overflow:scroll;margin-bottom: 5px;" data-language="html">
 +
<input type="number" name="attr_hp" step="any" value="10" min="0" max="20" /> <input type="text" name="attr_hp_misc" value="" placeholder="Other info about hp" />
 +
<label>Robust? <input type="checkbox" name="attr_hp_robust" value="1" title="Check the box if your character is Robust" /></label>
 +
</pre>
 +
 
 +
<pre style="overflow:scroll;margin-bottom: 5px;" data-language="css">
 +
div.sheet-d4 {
 +
    width: 35px;
 +
    height: 35px;
 +
    background-image: url("https://i.imgur.com/zkgyBOi.png");
 +
    background-repeat: no-repeat;
 +
    color: transparent;
 +
    display: none;
 +
}
 +
</pre>
 +
 
 +
<pre style="overflow:scroll;margin-bottom: 5px;" data-language="javascript">
 +
on("change:siz change:con sheet:opened", function() { 
 +
  getAttrs(["SIZ","CON"], function(values) {
 +
    let siz = parseInt(values.SIZ)||0;
 +
    let con = parseInt(values.CON)||0;
 +
    let hp = siz + con;
 +
    setAttrs({                           
 +
      "hitpoints": hp
 +
    });
 +
  });
 +
});
 +
</pre>
 +
 
 +
'''Click "Edit" for this section to see how the above examples work and the wiki code.'''
 +
 
 +
===Leaving Name/Timestamp===
 +
 
 +
If you want to sign your name & date to a message or section, you can quickly do so with writing four tilde characters.
 +
 
 +
'''Example:'''
 +
 
 +
I just remembered this is a feature on many wikis. [[User:1223200|1223200]] ([[User talk:1223200|talk]]) 12:35, 11 September 2020 (UTC)
 +
 
 +
<pre>I just remembered this is a feature on many wikis. ~~~~</pre>
 +
 
 +
===Dice Roller===
 +
You can integrate a copy of Roll20's dice roller on a wiki page, to enable people to try things out on the page, instead of forcing them to open a Roll20 game to test a roll or syntax. You can leave it empty, or include a default "roll" that people can use straight away instead of having to type it out.
 +
The user can edit what's in the dice roller as they want, but will show the original one if the page is reloaded.
 +
 
 +
The following [[Text Chat|command types]] work in the dice roller: <code>/r</code>, <code>/roll</code>, <code>/gr</code>, <code>/gmroll</code>
 +
 
 +
These doesn't work: <code>/em</code>, <code>/w</code>
 +
 
 +
Inline Roll Labels works in the Dice Roller.
 +
 
 +
'''Example:'''
 +
<div class='diceroller'>
 +
/r 3d6+2
 +
</div>
 +
 
 +
'''Wiki code:'''
 +
<pre>
 +
<div class='diceroller'>
 +
/r 3d6+2
 +
</div>
 +
</pre>
  
'''Click "Edit" for this page to see how the above examples work.'''
+
The {{Text Chat}} page displays a dice roller under the [[Text Chat#Rolling|Rolling]]-section, and the [[Dice Reference]] page have multiple examples.
  
 
===Advanced===
 
===Advanced===
Line 194: Line 338:
 
<pre>thumbnail, thumb, framed, frameless</pre>
 
<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
+
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.
 +
 
 +
The <code>thumbnail</code>-tag is most practical as you can both resize the image, as well as present descriptive text under it.
 +
 
 +
For some of the other tags you can't change the size of the image with some tags.
 +
 
 +
'''Image as a link:''' you can link to another wiki page or an external site, like [[File:Twitch.png|20px|link=http://www.twitch.tv/roll20app]] being a link to Roll20's twitch page.
 +
 
 +
<pre>
 +
[[File:Twitch.png|20px|link=http://www.twitch.tv/roll20app]]
 +
</pre>
  
 
<br>
 
<br>
Line 236: Line 390:
 
*** <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;">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;">#</span> <code><nowiki><span style="font-family:Pictos;">#</span></nowiki></code> Reset Fog
 +
** [[File:Udl-hide-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-hide-icon.jpg|middle|15px]]</nowiki></code> [[Darkness Tool]]
 +
*** [[File:Udl-reveal-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-reveal-icon.jpg|middle|15px]]</nowiki></code> Reveal
 +
*** [[File:Udl-perm_darkness-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-perm_darkness-icon.jpg|middle|15px]]</nowiki></code> Permanent Darkness
 +
*** [[File:Udl-explorer-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-explorer-icon.jpg|middle|15px]]</nowiki></code> Explorable Darkness
 +
*** [[File:Udl-polygon-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-polygon-icon.jpg|middle|15px]]</nowiki></code> Polygon
 +
*** [[File:Udl-rectangle-icon.jpg|middle|15px]] <code><nowiki>[[File:Udl-rectangle-icon.jpg|middle|15px]]</nowiki></code>Rectangle
 
** <span style="font-family:Pictos;">t</span> <code><nowiki><span style="font-family:Pictos;">t</span></nowiki></code> [[Turn Tracker]]
 
** <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]]
 
** <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]]
Line 242: Line 402:
 
'''[[Character Sheet]]'''
 
'''[[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> 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>/<code><nowiki>{{Lock}}</nowiki></code> Lock, repeating section
* <span style="font-family:Pictos;">)</span> <code><nowiki><span style="font-family:Pictos;">)</span></nowiki></code> Unlock, repeating section
+
* <span style="font-family:Pictos;">)</span> <code><nowiki><span style="font-family:Pictos;">)</span></nowiki></code>/<code><nowiki>{{Unlock}}</nowiki></code> Unlock, repeating section
* <span style="font-family:Pictos;">w</span> <code><nowiki><span style="font-family:Pictos;">w</span></nowiki></code> Send to chat
+
* '''<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>/<code><nowiki>{{Bubble}}</nowiki></code>  Send to chat
 +
* <span style="font-family:Pictos;">y</span> <code><nowiki><span style="font-family:Pictos;">y</span></nowiki></code>/<code><nowiki>{{Gear}}</nowiki></code> Settings, gear icon
 +
* <span style="font-family:Pictos;">x</span> <code><nowiki><span style="font-family:Pictos;">x</span></nowiki></code>/<code><nowiki>{{hammer}} or {{wrench}} </nowiki></code> Alternative Settings icon.
  
 
'''Dice'''
 
'''Dice'''
Line 253: Line 416:
 
* <span style="font-family:dicefontd10;">j</span> <code><nowiki><span style="font-family:dicefontd10;">j</span></nowiki></code> d10
 
* <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
 
* <span style="font-family:dicefontd12;">l</span> <code><nowiki><span style="font-family:dicefontd12;">l</span></nowiki></code> d12
 +
 +
===Other Logos & symbols===
 +
Github logo, useful for placing after links that lead there. [https://github.com/Roll20/roll20-character-sheets Roll20 Character Sheets] {{github}}
 +
<pre>Github logo, useful for placing after links that lead there.  [https://github.com/Roll20/roll20-character-sheets Roll20 Character Sheets]{{github}}</pre>
 +
 +
Common Roll20 icons with templates to show them: {{Lock}} {{Unlock}} {{Gear}} {{Hammer}}
 +
<pre>{{Lock}} {{Unlock}} {{Gear}} {{Hammer}} </pre>
  
 
===Youtube===
 
===Youtube===
You can have an embedded video on a page.
+
You can have an embedded youtube video on a page.
  
 
{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}
 
{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}
  
This can be achieved with:
+
This can be achieved with the following format. You need to copy the end of the url for your video and replace <code>MH78AOhNyuA</code> in the below example. Otherwise it seems to take the <code>right|center|left</code>-parameters, along with a numerical value which represent pixel-width of the video.
  
 
<code><nowiki>{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}</nowiki></code>
 
<code><nowiki>{{#evp:youtube|MH78AOhNyuA|Tutorial for the [[Drawing Tools]]|center|500}}</nowiki></code>
Line 269: Line 439:
 
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.
 
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.
  
====External Link====
 
If you want to link to a page outside the wiki, you need to use single brackets.
 
  
Example: [https://app.roll20.net/forum/ Roll20 Forums]
+
====Other Wiki Page====
 
+
How to link to other pages on the Roll20 Community Wiki.
<pre>[https://app.roll20.net/forum/ Roll20 Forums]</pre>
+
 
+
====Wiki Page====
+
  
 
'''Example:'''
 
'''Example:'''
Line 286: Line 451:
 
<pre>[[Main_Page|front page]]</pre>
 
<pre>[[Main_Page|front page]]</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 Article=====
 +
Shortcut to make a link to another article, and indicate it to be the main article on the subject.
  
 
{{main|Journal}}
 
{{main|Journal}}
Line 295: Line 465:
 
<pre>{{main|Journal}}</pre>
 
<pre>{{main|Journal}}</pre>
  
====Wiki Category====
+
=====Wiki Meta=====
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>
  
====Roll20 User====
+
'''Link to a wiki template:''' {{tlx|forum}} - <code><nowiki>{{tlx|forum}}</nowiki></code>
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.
+
 
 +
 
 +
====Roll20 links====
 +
Here are a few templates that makes linking to other parts of the roll20 site better, and make it obvious where the links leads.
 +
 
 +
=====User Profile=====
 +
You can link directly to a Roll20 user's profile from 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>[https://app.roll20.net/users/4/ Roll20 Dev Team]</pre>
 
<pre>{{user profile|4|Roll20 Dev Team}}</pre>
 
<pre>{{user profile|4|Roll20 Dev Team}}</pre>
 +
 +
 +
=====Forum=====
 +
A template that can be used to link to Roll20 forum post, showing the roll20 logo and saying it's a forum thread link.
 +
 +
Example: {{forum|post/125912/roll20-community-code-of-conduct Roll20 Community Code of Conduct}}
 +
 +
<pre>{{forum|post/125912/roll20-community-code-of-conduct Roll20 Community Code of Conduct}}</pre>
 +
The url placed in the forum-template is everything after <code><nomwiki>https://app.roll20.net/forum/</nowiki></code>, which the templates will ad automatically.
 +
 +
Compare {{forum|post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}} and [[https://app.roll20.net/forum/post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}]]
 +
 +
<pre>Compare {{forum|post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}} and [[https://app.roll20.net/forum/post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}]]</pre>
 +
 +
Documentation: {{tlx|forum}}
 +
 +
=====Blog=====
 +
 +
Link to Roll20 blog posts:
 +
 +
{{blog|posts/lost-mine-of-phandelver-roll20-q-a/ Lost Mine of Phandelver: Roll20 Q & A}}
 +
 +
<pre>
 +
{{blog|posts/lost-mine-of-phandelver-roll20-q-a/ Lost Mine of Phandelver: Roll20 Q & A}}
 +
</pre>
 +
 +
Documentation: {{tlx|blog}}
 +
 +
=====[[Help Center]]=====
 +
It's often useful to link to the Official Roll20 [[Help Center]] pages.
 +
 +
{{hc|categories/360003756533-Getting-Started Getting Started}}
 +
 +
<pre>
 +
{{hc|categories/360003756533-Getting-Started Getting Started}}
 +
</pre>
 +
 +
Documentation: {{tlx|hc}}
 +
 +
=====[[Marketplace]]=====
 +
 +
{{market| Roll20 Marketplace}}<br>
 +
{{market|browse/module/7363/free-spacer-ptolemy-sector-archive Free Spacer - Ptolemy Sector Archive}}<br>
 +
 +
<pre>
 +
{{market| Roll20 Marketplace}}<br>
 +
{{market|browse/module/7363/free-spacer-ptolemy-sector-archive Free Spacer - Ptolemy Sector Archive}}
 +
</pre>
 +
 +
Documentation: {{tlx|market}}
 +
 +
====External Link====
 +
If you want to link to a page outside the wiki, you need to use single brackets. There will appear a "lock" icon after the link to indicate it's  a link that goes outside the wiki.
 +
 +
Example: [https://blog.roll20.net/ Roll20 Blog]
 +
 +
<pre>[https://blog.roll20.net/ Roll20 Blog]</pre>
 +
 +
'''There are a few sites that have custom links that can make it easy to see where they lead''', and using them looks better than the normal single bracket method.
 +
 +
* '''Twitter:''' {{twitter|roll20app Roll20}}, {{twitter|roll20app/status/1360745454347169795 tweet by Roll20}} - {{tlx|twitter}}
 +
 +
=====Github=====
 +
A template you can use to link to code or other things that are on GitHub. It will also show a small Github icon after the link to show where it leads.
 +
 +
{{ex}} {{repo|Roll20/roll20-character-sheets  Roll20's Character Sheet Repository}},
 +
 +
<pre>{{repo|Roll20/roll20-character-sheets  Roll20's Character Sheet Repository}}</pre>
 +
The url placed in the forum-template is everything after <code><nomwiki>https://github.com/</nowiki></code>, which the templates will ad automatically.
 +
 +
{{ex}} {{gist|G-G-G/52b96cff0b827c42f9d04ab411fb42e8 code snippet}} by GiGs
 +
 +
<pre>
 +
{{gist|G-G-G/52b96cff0b827c42f9d04ab411fb42e8 code snippet}} by GiGs
 +
</pre>
 +
 +
 +
Documentation: {{tlx|repo}}, {{tlx|gist}}
 +
 +
=====Youtube=====
 +
{{yt|watch?v=xKXpKIiB5WM|Roll20 Crash Course - Rolling Dice}}  - {{yt.be|xKXpKIiB5WM Roll20 Crash Course - Rolling Dice}}
 +
<pre>
 +
{{yt|watch?v=xKXpKIiB5WM|Roll20 Crash Course - Rolling Dice}}
 +
{{yt.be|xKXpKIiB5WM Roll20 Crash Course - Rolling Dice}}
 +
</pre>
 +
 +
Documentation: {{tlx|yt}} and {{tlx|yt.be}}
 +
 +
=====Wikipedia=====
 +
Wikipedia link: [[wikipedia:HTML|HTML]]
 +
 +
<pre>[[wikipedia:HTML|HTML]]</pre>
  
 
===Categories===
 
===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:
 
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====
 
====Content====
Line 330: Line 602:
 
* '''[[:Category:Stubs]]''' for short articles that could use more content
 
* '''[[:Category:Stubs]]''' for short articles that could use more content
 
* '''[[:Category:Articles for deletion]]''' page that is clearly
 
* '''[[:Category:Articles for deletion]]''' page that is clearly
* '''[[:Category:Language-FR]]''' and '''[[:Category:Language-DE]]''' for french and german wiki articles
+
* '''[[:Category:Language-FR]]''' and '''[[:Category:Language-DE]]''' for french and german wiki  
 
+
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).
+
 
<br />
 
<br />
  
 
==='See Also' or 'Related Pages' section===
 
==='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
 
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==
* [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext#Tags_with_special_effect WikiMedia's documentation on formatting tags].
+
* [[sandbox]] - wiki page that contains lots of often useful wiki code snippets for editing the Roll20 Community Wiki. by [[Anduh|Andreas J.]]
 +
* https://www.mediawiki.org/wiki/Help:Magic_words
 +
* https://www.mediawiki.org/wiki/Help:Templates
 +
* [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext#Tags_with_special_effect WikiMedia's documentation on formatting tags]
 +
 
  
 
<br />
 
<br />
 
[[Category:Wiki Administration]]
 
[[Category:Wiki Administration]]

Revision as of 14:15, 14 February 2021

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-logo.png
 HelpCenter
for Official Documentation.
(that may or may not have more/better info than the Community Wiki) If the Official documentation have errors/mistakes, remember to .

Check Category:Stubs and Category:Tagged for Cleanup for pages that can really need help with updating.

The wiki editor

Contents

Contributing to the Wiki

If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia and Fandom Wikia), you can view a lot of helpful information on it here. The Roll20 Community Wiki runs on a somewhat older version of MediaWiki, so some newer features used elsewhere aren't avaiable, but at the core functions like other Wikis created with MediaWiki.

Wiki Purpose & Suggestions on what to add

Some ideas on what is a good fit for the Roll20 Community Wiki:

  1. Content that the entire community will find useful. Guides, Tips & tricks for variety of Roll20-related features, suggestions on how to implement certain elements in a game, pages with resources and links to relevant forum posts, pages on other sites, or video tutorials.
  2. Info & tips on playing a specific game on Roll20. Pages like Star Wars D6, WoD & Pathfinder contains various tips on how to play the games, and can serve as a hub with links to other relevant pages.
  3. Info & tips on how to use a specific character sheet. Roll20 have hundreds of community-contributed sheets & a handful of official sheets, of which only few have any extra info on how to use them, and all works slightly differently. All Official Character Sheets don't have documentation pages on the Help Center, and even when they do, the page might lack some info, so creating/updating the Community Wiki's version of the page could be a good idea. Sometimes even creating a short wiki page addressing a common issue with a sheet will make it easier for other to figure it out.
  4. If the Official Roll20 Help Desk is lacking Documentation for some feature, is confusing or too short, have errors, it can be a good idea to update the Community Wiki's page for the same topic. If a page for it doesn't exist, one can be created, and featuring the clarification to the feature, along with a link to the Helpdesk article. You could also copy the full article to the wiki, and then expand/edit it to your liking.
  5. Linking great forum posts on pages related to a topic/feature. If good advice on a topic exist on a number of forum threads, it can be enough to just create a new wiki page for the topic and give a list of links to the threads, instead of writing a full-blown article on it. Having a wiki page for a topic makes the info more accessible/findable, even if it just links to a couple of forum posts.


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.

Try give it a sensible & and shorter name if possible, then the page is more likely to be found when using the wiki's search. You can also create redirects to a page if you think it might be harder to find.

  • Example: 5E(wiki.roll20.net/5E) is the page displaying info related to D&D 5E, the most popular game on the platform, so makes sense to have a short and simple url.
  • Another example: the Linking Tokens to Journals page has Link Token as a redirect page, making the popular page easier to find, and even possible to remember the url itself.

Redirect page: create the new page, and add #REDIRECT [[name of the page it should link to]], then save it. no the new page redirect to the page you wanted. Example: #REDIRECT [[Help:Contents]] would redirect a page here.

Updating/Expanding the Wiki

Few thing to consider:

  1. After creating a new page, it's a good idea to add links to it on existing pages where it's relevant. If there is no links/mentions of a page, it's less likely to be found.
  2. If there is a good forum post or other place it relevant info, adding a link to the wiki page is a good idea.
  3. Add images if possible. by default users don't have image upload access, but you can submit a Helpdesk ticket for it, mentioning your user ID, and why you want image upload access.
  4. If someone show you an undocumented feature/quirk of Roll20, it would be a good idea to mention it on the relevant wiki page.
  5. If a wiki page starts to become very long, it might be a good idea to split of a large section that is self-contained and likely to become larger to it's own page, and then link to the full page on the original section, while reducing the text on the original page. Alternatively, you could put parts of the section in a Collapsible Section.
  6. The pages in the Category:Docs-Category are only to contain factual information on official Roll20 functionality or distinct features. These pages where originally created by the Roll20 Staff, but now that the wiki have turned into a Community Wiki, we can categorize new pages under it. Feel free to create additional pages outside that category using the Category:Guides, Category:Games and Category:Tips categories, or create subcategories when needed. See Help:Contents#Categories for longer list of existing categories.

Please don't

  1. Please don't use the wiki to post information relevant to specific games/Campaigns that you are running.
  2. Please don't use the wiki pages to lobby for changes to Roll20(doesn't have much reach anyway). Instead post to the Official Suggestions Forum or vote/comment on existing suggestions. Wiki Talk pages should be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.
  3. Don't use the wiki to ask questions about how Roll20 works, the Forums are better used for this. Basically nobody sees random new wiki, pages or if there are any talk pages, so it's pointless anyway.

Page formatting

A few tips and tricks can help make pages look better and more readable; here are a few main pointers.

You can check the sandbox page for some often useful code snippets, and you can create your own sandbox to test/play around in, by going to your own wiki page(link in the sidebar), and then adding /sandbox to the end of the url. hten you'll have a personal test page under your own profile without having to worry about testing if you want to do some large/wild edits.

General

Bold text:
'''Bold text'''
Italic text:
''Italic text''
Strikeout text:
<strike>Strikeout text</strike>
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.

See Heading Showcase for more info.

=Top Header=
The above creates the largest possible section heading, making the text blue

==Second Tier==
The above creates the second-largest possible section heading, with a black text. Subsequent headings are smaller and black.

Somwhere around Headings 5, the title tarts to become so small that it's hard to notice from the general text of an article, and normal, bold text pops out more.

Depending on how things look, the foollowing can be a good idea:

====='''manually bolded headings'''=====

Message Boxes

There are a number of different message boxes that can be used on the wiki, and here are shown the most useful ones.

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 alternative, but less flexible}}


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

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

Orange

{{orange| This section have sever issues and is likely out of date}}

The Template:Orange can be used to highlight some semi-important thing, if you don't want to use the much stronger/dire Template:Warning with it's sign, or if the blue Template:Notebox infobox doesn't convey enough urgency.

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 ~~~~
}}

It can be a good idea to quickly sign off your name & the date by using ~~~~, which will add your name & the date quickly. That will help other to know how long the section have been in need of cleanup.

Other

{{POV}}

Templates

There are a number of wiki templates that makes a number of things easier, here are a few of them. Most other templates are showcased in more specific sections of this page, such as image-related under Images.

  • {{tlx|Changelog version]] - usedful for creating API script or Character Sheet Changelogs
  • {{tlx|User profile]]
  • {{tlx|Multiple issues]]
  • {{repo}} - links to github code
  • Template:Ambox/doc - the core template used for making the several info & notice boxes
  • {{Mbox}} - meta-template is used to build message box
  • {{tlx}} - meta-template used for linking to the template's page and might display how it should be used.

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

{{pro only}}

{{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, where having mw-collapsed will make it collapsed by default:

{| 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}}

You can also make the TOC appear on the right side of the page with:

{{tocright}}

Displaying Macros and Code

If you add HTML code, or other code/macros to a wiki without precautions, the wiki will misunderstand is as MediaWiki code, and change how the page/text looks, instead of showing the raw code.

For showing short code snippets in flowing text, using the <code> element is a good idea(and sometimes adding <nowiki> inside it), but if you want to show a block of code with several rows, use the <pre>-element instead. Roll Template code is always tricky to show, so it should always be either inside a <pre>-element, or shown using <code> + <nowiki>.

For really tricky sections, you might want to try using HTML entities(replacement code) to replace some character, so that the character is shown on the page, but the wiki doesn't try to read it as if it's part of some code. This section contains a few examples of this(press Edit to see the code).

Examples to copy:

<code><nowiki>/r 2d5+@{attribute|max}+[[4d4]]</nowiki></code>
<pre style="overflow:scroll;margin-bottom: 5px;" data-language="html"> </pre>

Macro without formatting

A messy example:

/r 2d5+@{attribute|max}+4d4 damage

The macro code is just highlighted in italics using the Wiki formatting, and doesn't look good. 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".

Macro using <code> & <nowiki>

/r 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:
/r 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

Macro using <pre>

When surrounded by <pre> element, the macro is displayed in a separate code block, and not in the flowing text. Adding some CSS to make sure the code remains readable is a good idea, such as style="overflow:scroll;"

/em attacks for 2d5+@{attribute|max}+[[4d4]]

The above code is shown nice anc clean, without the wiki trying to do it's tricks.

Here is the wiki code for making a good & quick the pre element:

<pre style="overflow:scroll;margin-bottom: 5px;" data-language="html"> </pre>

Displaying HTML/CSS/Javascript code with syntax highlights

For displaying blocks of code like HTML/CSS/JavaScript on the wiki(like in the context of Character Sheet or API code), it's best to use the <pre> element, and additionally style the section with style="overflow:scroll;", and to add syntax highlight to make the code more readable with data-language="html/css/javascript"

<input type="number" name="attr_hp" step="any" value="10" min="0" max="20" /> <input type="text" name="attr_hp_misc" value="" placeholder="Other info about hp" />
<label>Robust? <input type="checkbox" name="attr_hp_robust" value="1" title="Check the box if your character is Robust" /></label>
div.sheet-d4 {
    width: 35px;
    height: 35px;
    background-image: url("https://i.imgur.com/zkgyBOi.png");
    background-repeat: no-repeat;
    color: transparent;
    display: none;
}
on("change:siz change:con sheet:opened", function() {  
  getAttrs(["SIZ","CON"], function(values) {
    let siz = parseInt(values.SIZ)||0;
    let con = parseInt(values.CON)||0;
    let hp = siz + con;
    setAttrs({                            
      "hitpoints": hp
    });
  });
});

Click "Edit" for this section to see how the above examples work and the wiki code.

Leaving Name/Timestamp

If you want to sign your name & date to a message or section, you can quickly do so with writing four tilde characters.

Example:

I just remembered this is a feature on many wikis. Andreas J. (talk) 12:35, 11 September 2020 (UTC)

I just remembered this is a feature on many wikis. ~~~~

Dice Roller

You can integrate a copy of Roll20's dice roller on a wiki page, to enable people to try things out on the page, instead of forcing them to open a Roll20 game to test a roll or syntax. You can leave it empty, or include a default "roll" that people can use straight away instead of having to type it out. The user can edit what's in the dice roller as they want, but will show the original one if the page is reloaded.

The following command types work in the dice roller: /r, /roll, /gr, /gmroll

These doesn't work: /em, /w

Inline Roll Labels works in the Dice Roller.

Example:

/r 3d6+2

Wiki code:

<div class='diceroller'>
/r 3d6+2
</div>

The q Text Chat page displays a dice roller under the Rolling-section, and the Dice Reference page have multiple examples.

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.

The thumbnail-tag is most practical as you can both resize the image, as well as present descriptive text under it.

For some of the other tags you can't change the size of the image with some tags.

Image as a link: you can link to another wiki page or an external site, like Twitch.png being a link to Roll20's twitch page.

[[File:Twitch.png|20px|link=http://www.twitch.tv/roll20app]]



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
    • Udl-hide-icon.jpg [[File:Udl-hide-icon.jpg|middle|15px]] Darkness Tool
      • Udl-reveal-icon.jpg [[File:Udl-reveal-icon.jpg|middle|15px]] Reveal
      • Udl-perm darkness-icon.jpg [[File:Udl-perm_darkness-icon.jpg|middle|15px]] Permanent Darkness
      • Udl-explorer-icon.jpg [[File:Udl-explorer-icon.jpg|middle|15px]] Explorable Darkness
      • Udl-polygon-icon.jpg [[File:Udl-polygon-icon.jpg|middle|15px]] Polygon
      • Udl-rectangle-icon.jpg [[File:Udl-rectangle-icon.jpg|middle|15px]]Rectangle
    • 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}} Lock, repeating section
  • ) <span style="font-family:Pictos;">)</span>/{{Unlock}} Unlock, repeating section
  • '''<big>≡</big>''' Reorder symbol, repeating section.
  • w <span style="font-family:Pictos;">w</span>/{{Bubble}} Send to chat
  • y <span style="font-family:Pictos;">y</span>/{{Gear}} Settings, gear icon
  • x <span style="font-family:Pictos;">x</span>/{{hammer}} or {{wrench}} Alternative Settings 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

Other Logos & symbols

Github logo, useful for placing after links that lead there. Roll20 Character Sheets GitHubLogo.png

Github logo, useful for placing after links that lead there.  [https://github.com/Roll20/roll20-character-sheets Roll20 Character Sheets]{{github}}

Common Roll20 icons with templates to show them: ( ) y x

{{Lock}} {{Unlock}} {{Gear}} {{Hammer}} 

Youtube

You can have an embedded youtube video on a page.

Tutorial for the Drawing Tools

This can be achieved with the following format. You need to copy the end of the url for your video and replace MH78AOhNyuA in the below example. Otherwise it seems to take the right|center|left-parameters, along with a numerical value which represent pixel-width of the video.

{{#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.


Other Wiki Page

How to link to other pages on the Roll20 Community Wiki.

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

Shortcut to make a link to another article, and indicate it to be the main article on the subject.

Main Page: Journal

{{main|Journal}}
Wiki Meta

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]]

Link to a wiki template: {{forum}} - {{tlx|forum}}


Roll20 links

Here are a few templates that makes linking to other parts of the roll20 site better, and make it obvious where the links leads.

User Profile

You can link directly to a Roll20 user's profile from 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}}


Forum

A template that can be used to link to Roll20 forum post, showing the roll20 logo and saying it's a forum thread link.

Example:
{{forum|post/125912/roll20-community-code-of-conduct Roll20 Community Code of Conduct}}

The url placed in the forum-template is everything after <nomwiki>https://app.roll20.net/forum/</nowiki>, which the templates will ad automatically.

Compare and [5E Bug thread}]
Compare {{forum|post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}} and [[https://app.roll20.net/forum/post/8033570/d-and-d-5th-edition-by-roll20-q1y2020 5E Bug thread}]]

Documentation: {{forum}}

Blog

Link to Roll20 blog posts:

Roll20-logo.png(Blog)
{{blog|posts/lost-mine-of-phandelver-roll20-q-a/ Lost Mine of Phandelver: Roll20 Q & A}}

Documentation: {{blog}}

Help Center

It's often useful to link to the Official Roll20 Help Center pages.

Roll20-logo.png
 HelpCenter
{{hc|categories/360003756533-Getting-Started Getting Started}}

Documentation: {{hc}}

Marketplace


{{market| Roll20 Marketplace}}<br>
{{market|browse/module/7363/free-spacer-ptolemy-sector-archive Free Spacer - Ptolemy Sector Archive}}

Documentation: {{market}}

External Link

If you want to link to a page outside the wiki, you need to use single brackets. There will appear a "lock" icon after the link to indicate it's a link that goes outside the wiki.

Example: Roll20 Blog

[https://blog.roll20.net/ Roll20 Blog]

There are a few sites that have custom links that can make it easy to see where they lead, and using them looks better than the normal single bracket method.

Github

A template you can use to link to code or other things that are on GitHub. It will also show a small Github icon after the link to show where it leads.


Example:
GitHubLogo.png,
{{repo|Roll20/roll20-character-sheets  Roll20's Character Sheet Repository}}

The url placed in the forum-template is everything after <nomwiki>https://github.com/</nowiki>, which the templates will ad automatically.


Example:
GitHubLogo.png by GiGs
{{gist|G-G-G/52b96cff0b827c42f9d04ab411fb42e8 code snippet}} by GiGs


Documentation: {{repo}}, {{gist}}

Youtube
Youtube-logo.png - Youtube-logo.png
{{yt|watch?v=xKXpKIiB5WM|Roll20 Crash Course - Rolling Dice}}
{{yt.be|xKXpKIiB5WM Roll20 Crash Course - Rolling Dice}}

Documentation: {{yt}} and {{yt.be}}

Wikipedia

Wikipedia link: HTML

[[wikipedia:HTML|HTML]]

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