Roll20 Wiki

Revision as of 12:35, 21 September 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. If the Official documentation have errors/mistakes, remember to report it.

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

The wiki editor

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 here.

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

Please don't

Please don't use it to post information relevant to a specific game/Campaign that you are running.
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 about how Roll20 works, the Forums are better used for this. Basically nobody sees random new iki pages or if there are any talk pages,

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:

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

Page formatting

A few tips and tricks can help make pages look better and more readable; here are a 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

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

Insert Whatever You Want to Say Here

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

It can be a good idea to quickly sign off your name & the date with ~~~~ on when the cleanup message was left.

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

Template:Compact_toc/doc

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.

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. 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 q Text Chat tab
- P P Art Library tab
- N N Journal tab
- i i Compendium tab
- u u Jukebox tab
- l l Collections tab
- y y My Settings tab

Toolbox
- w w Select and Pan Tool
 - [[File:Hand.png|middle|15px]] Pan mode
- b b Layers
 - @ @ Map & Background layer
 - b b Objects & Tokens layer
 - E E GM Info Overlay layer
 - r r Dynamic Lighting layer
- i i Drawing Tools
 - a a Draw Shapes tool
 - c c Polygon/Line Tool
 - q qText Tool
 - # # Clear Drawings tool
- e e FX Tool
- s s Zoom Tool
- [[File:Ruler.png|middle|15px]] Ruler Tool
- E E Fog of War
 - E E Reveal
 - c c Polygon Reveal
 - C C Hide Areas
 - # # Reset Fog
- [[File:Udl-hide-icon.jpg|middle|15px]] Darkness Tool
 - [[File:Udl-reveal-icon.jpg|middle|15px]] Reveal
 - [[File:Udl-perm_darkness-icon.jpg|middle|15px]] Permanent Darkness
 - [[File:Udl-explorer-icon.jpg|middle|15px]] Explorable Darkness
 - [[File:Udl-polygon-icon.jpg|middle|15px]] Polygon
 - [[File:Udl-rectangle-icon.jpg|middle|15px]]Rectangle
- t t Turn Tracker
- t <big>t</big> Dice Rolling GUI
- ? ? Help Tool

Character Sheet

& & Add, repeating section
( ( Lock, repeating section
) ) Unlock, repeating section
≡ '''<big>≡</big>''' Reorder symbol, repeating section.
w w Send to chat
y y Settings option, gear icon

Dice

t t d20
d d d4
f f d6
h h d8
j j d10
l l 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}}

'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

@@ Line 223: / Line 223: @@
 These doesn't work: <code>/em</code>, <code>/w</code>
+Inline Roll Labels works in the Dice Roller.
 '''Example:'''
 <div class='diceroller'>
-/roll 1d20+5
+/r 3d6+2
 </div>
@@ Line 232: / Line 234: @@
 <pre>
 <div class='diceroller'>
-/roll 1d20+5
+/r 3d6+2
 </div>
 </pre>
+The {{Text Chat}} page displays a dice roller under the [[Text Chat#Rolling|Rolling]]-section, and the [[Dice Reference]] page have multiple examples.
 ===Advanced===

Roll20 Wiki

Navigation

Personal tools

Toolbox

Difference between revisions of "Help:Contents"

From Roll20 Wiki

Revision as of 12:35, 21 September 2020

Contents

Contributing to the Wiki

Please don't

Create New Page

Updating/Expanding the Wiki

Page formatting

General

Headings

Message Boxes

Standard

Orange

Warning

Cleanup

Templates

Collapsible Section

Table of Content

Displaying Macros and other Code Snippets

Leaving Name/Timestamp

Dice Roller

Advanced

Images & Videos

Images

Roll20 UI Icons

Youtube

Structure

Links

External Link

Wiki Page

Main Article

Wiki Category

Roll20 User

Categories

Content

Wiki Administration

'See Also' or 'Related Pages' section

See also