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
(Using the Wiki)
(Message Boxes)
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
  
 
* 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 (listed on the front-page on the left-hand side) are only to contain factual information on official Roll20 functionality. Feel free to create additional pages outside that category for workarounds and other non-official tips.
+
* 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.
 
* Please do not use wiki pages to lobby for changes to Roll20 features. That's what the Suggestions forum is for. 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. That's what the Suggestions forum is for. Talk pages should only be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.
  
Line 10: Line 10:
 
==Using the Wiki==
 
==Using the Wiki==
  
If you're new to the MediaWiki software that we're utilizing (the same used to power Wikipedia), u can view a lot of helpful information on it here: https://meta.wikimedia.org/wiki/Help:Contents
+
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].
 +
 
 +
===Categories===
 +
There are a series of wiki categories to keep pages organized. The ones available for use are:
 +
* '''Games''': For thorough run-through of how to play a particular tRPG system in Roll20
 +
* '''Guides''': Many pages under the Games category fall in here too; anything extensively explained should use this category
 +
* '''Tips''': For smaller pages that cover a portion of the Roll20 platform (I.e. tips and tricks)
 +
* '''Marketplace''': This Category are for creators regarding their content placed on the Roll20 Marketplace<br />
 +
 
 +
 
 +
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 />
 +
===Uploading Images===
 +
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.<br />
 +
===Message Boxes===
 +
<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 />
 +
To add a message box to a wikipage, use this insert:<br />
 +
<pre>{{mbox | text = Insert Whatever You Want to Say Here}}</pre>
 +
 
 +
===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 family used for the Roll20 icons is called [http://pictos.cc/classic/font Pictos] and it is 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.
 +
 
 +
When you want to add an icon in your wiki, include this HTML snippet:<pre><span style="font-family:Pictos;">n</span></pre>
 +
 
 +
The letter "n" in the above example is whatever character you need to display the desired icon.
 +
 
 +
===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 <code>&#60;pre&#62;</code> tags.
 +
 
 +
A messy example:<br />
 +
''/roll 2d5+@{attribute|max}+[[4d4]]''<br />
 +
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 />
 +
<pre>/roll 2d5+@{attribute|max}+[[4d4]]</pre>
 +
 
 +
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.
 +
<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.'''
 +
 
 +
See also [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext#Tags_with_special_effect WikiMedia's documentation on formatting tags].

Revision as of 18:16, 28 January 2019

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!

That said, 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 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.
  • Please do not use wiki pages to lobby for changes to Roll20 features. That's what the Suggestions forum is for. Talk pages should only be used to discuss changes that need to be made to the wiki page itself or to clarify existing functionality.


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.

Categories

There are a series of wiki categories to keep pages organized. The ones available for use are:

  • Games: For thorough run-through of how to play a particular tRPG system in Roll20
  • Guides: Many pages under the Games category fall in here too; anything extensively explained should use this category
  • Tips: For smaller pages that cover a portion of the Roll20 platform (I.e. tips and tricks)
  • Marketplace: This Category are for creators regarding their content placed on the Roll20 Marketplace


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

Uploading Images

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.

Message Boxes



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

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

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 family used for the Roll20 icons is called Pictos and it is 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.

When you want to add an icon in your wiki, include this HTML snippet:
<span style="font-family:Pictos;">n</span>

The letter "n" in the above example is whatever character you need to display the desired icon.

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

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.

See also WikiMedia's documentation on formatting tags.