Difference between revisions of "Character Sheet Development/Common Mistakes"
From Roll20 Wiki
Andreas J. (Talk | contribs) m (fix headings) |
Andreas J. (Talk | contribs) (more links, update descriptions, started work on better TOC) |
||
| (One intermediate revision by one user not shown) | |||
| Line 3: | Line 3: | ||
{{main|Building Character Sheets}} | {{main|Building Character Sheets}} | ||
| − | This is a list of common mistakes many do in sheet | + | This is a list of common mistakes many do in sheet development. reorganized version of the ones found on [[BCS#Common_Mistakes]]. |
| − | < | + | '''The section headings are made this way to make it easier to reference individual rules by number, like <code><nowiki>https://wiki.roll20.net/Common_Mistakes_-_Sheet_Development#5</nowiki></code>''' |
| − | + | ||
| + | <!--- the TOC is ugly now, having two links to each section, but makes for shorter urls when linking to each section. Below I have a WIP of a manually created TOC that could look better than the normal TOC. | ||
| + | |||
| + | __NOTOC__ | ||
| + | |||
| + | '''Common (Roll20) Mistakes''' | ||
| + | * [[#1|#1 : Forgetting to start attribute names with <code>attr_</code>]] | ||
| + | * [[#2|#2 : Thinking the Preview Panel shows all the changes/is accurate]] | ||
| + | * [[#3|#3 : Check/Uncheck "Legacy Sanitization" when using custom code]] | ||
| + | * [[#4|#4 : | ||
| + | * [[#5|#5 : | ||
| + | * [[#6|#6 : | ||
| + | * [[#7|#7 : | ||
| + | * [[#8|#8 : | ||
| + | * [[#9|#9 : | ||
| + | |||
| + | '''General Coding Mistakes''' | ||
| + | * [[#G-1|#G-1: | ||
| + | * [[#G-2|#G-2: | ||
| + | * [[#G-3|#G-3: | ||
| + | |||
| + | --> | ||
| + | |||
| + | ==Common Mistakes==</noinclude> | ||
| + | A list of common mistakes made by both old and new sheet creators/[[Sheet Author|authors]]. | ||
===1=== | ===1=== | ||
====Forgetting to start attribute names with <code>attr_</code>==== | ====Forgetting to start attribute names with <code>attr_</code>==== | ||
| − | ( | + | (Works: <code><input type="number" name="attr_dexterity"></code> vs. Doesn't work: <code><input type="number" name="dexterity"></code>). To [[Building_Character_Sheets#Storing_User_Data|store any information]] on a character sheet, this <code>attr_</code> prefix is needed in the name. If it is left out, no data being saved in the field after the sheet is closed. |
===2=== | ===2=== | ||
| − | ====Thinking the [[Building_Character_Sheets#Preview_Panel| Preview Panel]] shows all the changes/is accurate | + | ====Thinking the [[Building_Character_Sheets#Preview_Panel|Preview Panel]] shows all the changes/is accurate==== |
| − | The preview panel does '''not''' show an accurate view of how the sheet will look/work in an actual game, '''and completely ignores sheetworkers'''. You need to login to the campaign and open a character sheet there to be sure of sheet visuals/functionality, or use the [[Sheet Sandbox]]. | + | The preview panel does '''not''' show an accurate view of how the sheet will look/work in an actual game, '''and completely ignores [[sheetworkers]]'''. You need to login to the campaign and open a character sheet there to be sure of sheet visuals/functionality, or use the [[Sheet Sandbox]]. |
===3=== | ===3=== | ||
| − | ====Check/Uncheck "[[Legacy Sheet|Legacy Sanitization]]" when using custom code | + | ====Check/Uncheck "[[Legacy Sheet|Legacy Sanitization]]" when using custom code==== |
| − | Depending on if you have sheet code formatted for [[LCS]] or [[CSE]], you need to check the box found | + | Depending on if you have sheet code formatted for [[LCS|Legacy sheets]] or [[CSE]], you need to check the box found in the [[Sheet Editor]], or when using [[Sheet Sandbox]], update the [[Custom_Sheet_Sandbox#Sheet.json_Editor|sheet.json]]-section. |
===4=== | ===4=== | ||
| Line 25: | Line 48: | ||
===5=== | ===5=== | ||
| − | ====Using an underscore in the name/class of [[ | + | ====Using an underscore in the name/class of [[Repeating_Sections|repeating sections]]==== |
| − | Each <code><fieldset></code> needs to have unique classname that starts with <code>repeating_</code>, and the rest of the name cannot have underscores, or the section won't save any information. Using <code>-</code> is fine, but might be smarter to write it as one word. | + | Each <code><fieldset></code> needs to have unique classname, that starts with <code>repeating_</code>, and the rest of the name cannot have underscores, or the section won't save any information. Using <code>-</code> is fine, but might be smarter to write it as one word. '''Good ex.''' <code><fieldset class="repeating_meleeattacks"></code> |
===6=== | ===6=== | ||
| − | ====CSS: Not understanding how [https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator General Sibling Selector] <code>~</code> works, and how it applies in making tabs/hideable areas on the sheet | + | ====CSS: Not understanding how [https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator General Sibling Selector] <code>~</code> works, and how it applies in making tabs/hideable areas on the sheet==== |
| − | The [[ | + | The [[CSS Wizardry]] examples on [[CSS_Wizardry#Show.2FHide_Areas|show/hide areas]] & creating [[CSS_Wizardry#Tabs|tabs on your sheet]], relies on the correct positioning of elements. If the HTML elements are in a different order, or are inside other elements, the conditions aren't met for making the <code>~</code> selector work in CSS. |
===7=== | ===7=== | ||
====Not using a [[Sheet_Author_Tips#Code_Validation|linter/code validator]] on your HTML/CSS/Sheetworker/Translation files.==== | ====Not using a [[Sheet_Author_Tips#Code_Validation|linter/code validator]] on your HTML/CSS/Sheetworker/Translation files.==== | ||
| − | Often with HTML/CSS things can seemingly work fine for a long time even when you have mistakes, and cause trouble way later. Running your Sheetworker's code through a [https://closure-compiler.appspot.com/home JavaScript validator] is a critical step to finding why it might not work. Checking any <code>translation.json</code> or <code>sheet.json</code> files is also important. | + | Often with HTML/CSS things can seemingly work fine for a long time even when you have mistakes, and cause trouble way later. Running your Sheetworker's code through a [https://closure-compiler.appspot.com/home JavaScript validator] is a critical step to finding why it might not work. Checking any <code>translation.json</code> or <code>sheet.json</code> files is also important. [[Sheet_Author_Tips#Code_Validation|HTML/CSS code validation]] |
===8=== | ===8=== | ||
====Google Fonts==== | ====Google Fonts==== | ||
| − | Follow the Roll20 guide to the letter, and don't use urls generated by google, you need the remove the "2" from the url, among things. [[#Google_Fonts|Google Fonts on Roll20 Sheets]] | + | Follow the Roll20 guide to the letter, and don't use urls generated by google, you need the remove the "2" from the url, among things. [[BCS#Google_Fonts|Google Fonts on Roll20 Sheets]] |
===9=== | ===9=== | ||
====Do not submit a new sheet that uses <code><nowiki><table></nowiki></code> for layout.==== | ====Do not submit a new sheet that uses <code><nowiki><table></nowiki></code> for layout.==== | ||
| − | It's the most common reason for new sheets being rejected/delayed, | + | It's the most common reason for new sheets being rejected/delayed, use better methods for layout instead, such as [[Designing_Character_Sheet_Layout#CSS_Grid|CSS Grid]] or [[Designing_Character_Sheet_Layout#CSS_Flexbox|Flexbox]]. There are old sheets in the repo using <code><nowiki><table></nowiki></code>, but they where created before this rule against <code><nowiki><table></nowiki></code> was made. |
| − | == | + | ==General Coding Mistakes== |
| + | The kinda obvious, general coding mistakes, that aren't related to how Roll20 sheets code works specifically, but are general coding things to keep in mind, regardless of subject. | ||
| − | === | + | ===G-1=== |
====Not reading the Roll20 documentation.==== | ====Not reading the Roll20 documentation.==== | ||
| − | Much of the quirks & basics related to Character Sheet Creation is documented on | + | Roll20 sheet code isn't straight up just regular HTML/CSS/JavaScript, but has a number of differences Much of the quirks & basics related to Character Sheet Creation is documented/linked on [[Building Character Sheets]], and the pages are regularly getting updated. It's always a good idea to check pages again, even if you read them in the past. List of [[:Category:Character Sheet Creation|all pages related to "Character Sheet Creation"]] |
| − | + | * [[Building_Character_Sheets#Restrictions|Restrictions]] - general html/css restrictions on how things differ from normal html/css | |
| − | + | * [[Sheet_Worker_Scripts#JavaScript_Restrictions|Sheetworker Restrictions]] - how JS is restricted, & info on what sheetworkers can or can't do. | |
| − | + | * [[Repeating_Sections#Definition_.26_Restrictions|Repeating Sections Restrictions]] - how they differ from regular sheet sections | |
| + | * [[Building Character Sheets/Roll Templates#Restrictions|Roll Templates Restrictions]] - works very differently from the actual sheet code, and affects how they are written | ||
| − | === | + | ===G-2=== |
| + | ====Not looking at existing code.==== | ||
| + | Seeing how {{repo|Roll20/roll20-character-sheets existing sheets}} have been made and structured can help you avoid reinventing the wheel or making many of the common mistakes as result of knowing HTML/CSS/JavaScript, but not taking time to get familiar with how Roll20 sheet code is slightly different. All sheets in the {{repo|Roll20/roll20-character-sheets Character Sheet Repository}} are under MIT license so are free(and encouraged) to be used as templates for creating your own sheet, instead of making everything from scratch. | ||
| + | |||
| + | * [[Building_Character_Sheets#Complete_Example|Existing Sheets - good examples]] | ||
| + | * [[Building_Character_Sheets#Sheet_Templates.2FExamples|Sheet Templates]] | ||
| + | |||
| + | ===G-3=== | ||
====Not asking for help when you get stuck==== | ====Not asking for help when you get stuck==== | ||
| − | Roll20 has a small but active community who works with creating and improving character sheets, and are often eager to help out if you got stuck on some feature you've tried to figure out. {{forum|category/277980 Roll20 Character Sheet & Compendium Forums}} | + | Roll20 has a small, but active, community who works with creating and improving character sheets, and are often eager to help out if you got stuck on some feature you've tried to figure out. |
| + | |||
| + | * {{forum|category/277980 Roll20 Character Sheet & Compendium Forums}} - best place to ask for advice | ||
| + | * [https://discordapp.com/invite/sMsv5KD Unofficial Roll20 Discord] - a number of [[Sheet Author|sheet authors]] are active there, in the ''#custom-sheets'' channel(as well as in their own hub). | ||
<noinclude> | <noinclude> | ||
<br> | <br> | ||
==Related Pages== | ==Related Pages== | ||
| − | * [[Sheet Author Tips]] - tips not covered | + | * [[Sheet Author Tips]] - misc. tips not covered by other pages |
* [[Sheet Sandbox]] - the better sheet editor to use when working on char sheets | * [[Sheet Sandbox]] - the better sheet editor to use when working on char sheets | ||
<br> | <br> | ||
Revision as of 14:40, 5 May 2021
Character Sheet Development
Getting Started
- Using Custom Sheets
- Building Sheets
(Main Page) - Code Restrictions
- Best Practice
- Common Mistakes
- Tutorials
- Examples, Templates
- Pattern Libraries
- HTML & storing data
- CSS & Styling
General
- Updates & Changelog
- Known Bugs
- Character Sheet Enhancement(CSE)
- Custom Roll Parsing
- Legacy Sheet(LCS)
Reference
- Buttons
- Repeating Sections
- Sheetworkers
- Roll Templates
- sheet.json
- Translation
- Auto-Calc
- Advanced
- All SheetDev Pages
Tools & Tips
Git/GitHub 
Other
Main Page: Building Character Sheets
This is a list of common mistakes many do in sheet development. reorganized version of the ones found on BCS#Common_Mistakes.
The section headings are made this way to make it easier to reference individual rules by number, like https://wiki.roll20.net/Common_Mistakes_-_Sheet_Development#5
Contents |
Common Mistakes
A list of common mistakes made by both old and new sheet creators/authors.
1
Forgetting to start attribute names with attr_
(Works: <input type="number" name="attr_dexterity"> vs. Doesn't work: <input type="number" name="dexterity">). To store any information on a character sheet, this attr_ prefix is needed in the name. If it is left out, no data being saved in the field after the sheet is closed.
2
Thinking the Preview Panel shows all the changes/is accurate
The preview panel does not show an accurate view of how the sheet will look/work in an actual game, and completely ignores sheetworkers. You need to login to the campaign and open a character sheet there to be sure of sheet visuals/functionality, or use the Sheet Sandbox.
3
Check/Uncheck "Legacy Sanitization" when using custom code
Depending on if you have sheet code formatted for Legacy sheets or CSE, you need to check the box found in the Sheet Editor, or when using Sheet Sandbox, update the sheet.json-section.
4
(Legacy Sheet)Forgetting to add sheet- to the class names in your .css file.
This is not need in the .html file, Roll20 automatically assumes all classes have that prefix there.(Doesn't apply to CSE sheets) See CSS Styling
5
Using an underscore in the name/class of repeating sections
Each <fieldset> needs to have unique classname, that starts with repeating_, and the rest of the name cannot have underscores, or the section won't save any information. Using - is fine, but might be smarter to write it as one word. Good ex. <fieldset class="repeating_meleeattacks">
6
CSS: Not understanding how General Sibling Selector ~ works, and how it applies in making tabs/hideable areas on the sheet
The CSS Wizardry examples on show/hide areas & creating tabs on your sheet, relies on the correct positioning of elements. If the HTML elements are in a different order, or are inside other elements, the conditions aren't met for making the ~ selector work in CSS.
7
Not using a linter/code validator on your HTML/CSS/Sheetworker/Translation files.
Often with HTML/CSS things can seemingly work fine for a long time even when you have mistakes, and cause trouble way later. Running your Sheetworker's code through a JavaScript validator is a critical step to finding why it might not work. Checking any translation.json or sheet.json files is also important. HTML/CSS code validation
8
Google Fonts
Follow the Roll20 guide to the letter, and don't use urls generated by google, you need the remove the "2" from the url, among things. Google Fonts on Roll20 Sheets
9
Do not submit a new sheet that uses <table> for layout.
It's the most common reason for new sheets being rejected/delayed, use better methods for layout instead, such as CSS Grid or Flexbox. There are old sheets in the repo using <table>, but they where created before this rule against <table> was made.
General Coding Mistakes
The kinda obvious, general coding mistakes, that aren't related to how Roll20 sheets code works specifically, but are general coding things to keep in mind, regardless of subject.
G-1
Not reading the Roll20 documentation.
Roll20 sheet code isn't straight up just regular HTML/CSS/JavaScript, but has a number of differences Much of the quirks & basics related to Character Sheet Creation is documented/linked on Building Character Sheets, and the pages are regularly getting updated. It's always a good idea to check pages again, even if you read them in the past. List of all pages related to "Character Sheet Creation"
- Restrictions - general html/css restrictions on how things differ from normal html/css
- Sheetworker Restrictions - how JS is restricted, & info on what sheetworkers can or can't do.
- Repeating Sections Restrictions - how they differ from regular sheet sections
- Roll Templates Restrictions - works very differently from the actual sheet code, and affects how they are written
G-2
Not looking at existing code.
Seeing how existing sheets have been made and structured can help you avoid reinventing the wheel or making many of the common mistakes as result of knowing HTML/CSS/JavaScript, but not taking time to get familiar with how Roll20 sheet code is slightly different. All sheets in the Character Sheet Repository are under MIT license so are free(and encouraged) to be used as templates for creating your own sheet, instead of making everything from scratch.
G-3
Not asking for help when you get stuck
Roll20 has a small, but active, community who works with creating and improving character sheets, and are often eager to help out if you got stuck on some feature you've tried to figure out.
- Roll20 Character Sheet & Compendium Forums(Forum) - best place to ask for advice
- Unofficial Roll20 Discord - a number of sheet authors are active there, in the #custom-sheets channel(as well as in their own hub).
Related Pages
- Sheet Author Tips - misc. tips not covered by other pages
- Sheet Sandbox - the better sheet editor to use when working on char sheets
