Home
Games
Marketplace
Compendium Character Vault Roll20 for iPad and Android
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 "Character Sheet Development/Common Mistakes"

From Roll20 Wiki

Jump to: navigation, search
(replacing automatic ToC with manually created ToC that looks/behaves better)
m (→‎Do not submit a new sheet that uses for layout.)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
−
{{NavSheetDoc}}
+
{{revdate}}{{BCS}}
−
{{main|Building Character Sheets}}
+
−
{{pro only}}
+
  
−
 
+
This is a list of common mistakes many do in sheet development when [[BCS|creating or editing custom character sheets]]. reorganized version of the ones found on [[BCS#Common_Mistakes]].{{NavSheetDoc}}
−
This is a list of common mistakes many do in sheet development when [[BCS|creating or editing custom character sheets]]. 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/Sheet_Mistakes#5</nowiki></code>'''
 
The section headings are made this way to make it easier to reference individual rules by number, like <code><nowiki>https://wiki.roll20.net/Sheet_Mistakes#5</nowiki></code>'''
Line 13: Line 10:
 
If you edit/add sections on the page, update the TOC accordingly. -->
 
If you edit/add sections on the page, update the TOC accordingly. -->
 
__NOTOC__
 
__NOTOC__
−
<div id="toc" class="toc" style="font-size:1em;">
+
<div id="toc" class="toc" style="font-size:1em;width:800px;">
 
<div style="font-size:1.4em;margin-bottom:0px;" >Contents</div>
 
<div style="font-size:1.4em;margin-bottom:0px;" >Contents</div>
 
<hr>
 
<hr>
 
<div style="margin-bottom:5px;">'''[[#Common Mistakes|Common (Roll20) Mistakes]]'''</div>
 
<div style="margin-bottom:5px;">'''[[#Common Mistakes|Common (Roll20) Mistakes]]'''</div>
 
<p style="margin-left: 1.6em;margin-bottom:5px;">
 
<p style="margin-left: 1.6em;margin-bottom:5px;">
−
[[#1|1 : Forgetting to start attribute names with <code>attr_</code>]]<br>
+
[[#1|1 : Forgetting to start attribute names with <code>attr_</code>]]<br>
−
[[#2|2 : Thinking the Preview Panel shows all the changes/is accurate]]<br>
+
[[#2|2 : The Preview Panel is not accurate]]<br>
−
[[#3|3 : Check/Uncheck "Legacy Sanitization" when using custom code]]<br>
+
[[#3|3 : Check/Uncheck "Legacy Sanitization" when using custom code]]<br>
−
[[#4|4 : (Legacy Sheet)Forgetting to add sheet- to the class names in your .css file]]<br>
+
[[#4|4 : (Legacy Sheet)Forgetting to add sheet- to the class names in your .css file]]<br>
−
[[#5|5 : Using an underscore in the name/class of repeating sections]]<br>
+
[[#5|5 : Using an underscore in the name/class of repeating sections]]<br>
−
[[#6|6 : CSS: Not understanding how General Sibling Selector <code>~</code> works, and how it applies in making tabs/hideable areas on the sheet]]<br>
+
[[#6|6 : CSS: Not understanding how General Sibling Selector <code>~</code> works, and how it applies in making tabs/hideable areas on the sheet]]<br>
−
[[#7|7 : Not using a linter/code validator on your HTML/CSS/Sheetworker/Translation files]]<br>
+
[[#7|7 : Not using a linter/code validator on your HTML/CSS/Sheetworker/Translation files]]<br>
−
[[#8|8 : Google Fonts]]<br>
+
[[#8|8 : Google Fonts]]<br>
−
[[#9|9 : Do not submit a new sheet that uses <code><nowiki><table></nowiki></code> for layout]]
+
[[#9|9 : Do not submit a new sheet that uses <code><nowiki><table></nowiki></code> for layout]]<br>
 +
[[#10|10: Forgetting about translation files]]
 
</p>
 
</p>
 
<div style="margin-bottom:5px;">'''[[#General Coding Mistake|General Coding Mistakes]]'''</div>
 
<div style="margin-bottom:5px;">'''[[#General Coding Mistake|General Coding Mistakes]]'''</div>
Line 44: Line 42:
  
 
===2===
 
===2===
−
====Thinking the [[Building_Character_Sheets#Preview_Panel|Preview Panel]] shows all the changes/is accurate====
+
====The [[Sheet_Editor#Preview|Preview Panel]] is not 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.
 +
 
 +
'''Ideally, use the [[Sheet Sandbox]] for sheet development.'''
  
 
===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|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.
 
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.
 +
 +
Otherwise the sheet will look like most of the CSS is gone, and the result is often basically unusable.
  
 
===4===
 
===4===
 
====([[Legacy Sheet]])Forgetting to add <code>sheet-</code> to the class names in your <code>.css</code> file.====
 
====([[Legacy Sheet]])Forgetting to add <code>sheet-</code> to the class names in your <code>.css</code> file.====
−
This is not need in the <code>.html</code> file, Roll20 automatically assumes all classes have that prefix there.(Doesn't apply to [[CSE]] sheets) See [[Building Character Sheets#CSS Styling|CSS Styling]]
+
This is not needed in the <code>.html</code> file, Roll20 automatically assumes all classes have that prefix there.(Doesn't apply to [[CSE]] sheets) See [[Building Character Sheets#CSS Styling|CSS Styling]]
  
 
===5===
 
===5===
−
====Using an underscore in the name/class of [[Repeating_Sections|repeating sections]]====
+
====Using an underscore in the name/class of [[BCS/Repeating Section|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. '''Good ex.''' <code><fieldset class="repeating_meleeattacks"></code>
 
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>
  
Line 73: Line 75:
 
===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, 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.
+
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 were created before this rule against <code><nowiki><table></nowiki></code> was made.
  
 +
===10===
 +
====Forgetting about translation files====
 +
Forgetting to use or update [[i18n|translation files]] will result in the {{c|data-i18n}} attribute from the html to show as red like {{red|[strength]}} to indicate the translation is missing. If the sheet needs the translation file, and you don't copy it to your game, all/most text on it will show red text and the name of the language tag for each section, as seen in the [[Using_Custom_Character_Sheets#Common_Mistake|example here]].
  
 
==General Coding Mistakes==
 
==General Coding Mistakes==
Line 85: Line 90:
 
* [[Building_Character_Sheets#Restrictions|Restrictions]] - general html/css restrictions on how things differ from normal html/css
 
* [[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.
 
* [[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
+
* [[BCS/Repeating_Section#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
 
* [[Building Character Sheets/Roll Templates#Restrictions|Roll Templates Restrictions]] - works very differently from the actual sheet code, and affects how they are written
 
* '''[[BCS/Updates]]''' Recent updates to how sheets functions
 
* '''[[BCS/Updates]]''' Recent updates to how sheets functions
Line 109: Line 114:
  
 
==Related Pages==
 
==Related Pages==
 +
* [[Character Sheet Development/Bugs & Quirks]]
 +
* [[Character Sheet Development/Feature Updates]]
 
* [[Sheet Author Tips]] - misc. tips not covered by other pages
 
* [[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>
+
 
[[Category:Character Sheet Creation]]
 
[[Category:Character Sheet Creation]]
 +
[[Category:Character Sheet Development]]
 
</noinclude>
 
</noinclude>

Latest revision as of 19:42, 24 August 2023

Wiki-Logo 75x49.png
Page Updated:
  2023-08-24
Octicons-terminal.png
This is related to Editing(coding) Character Sheets, which require
Pro
info to be able to use.
Main Page: Building Character Sheets
This is a list of common mistakes many do in sheet development when creating or editing custom character sheets. reorganized version of the ones found on BCS#Common_Mistakes.

Character Sheet Development
Getting Started

General

Reference

Tools & Tips

Git/GitHub Githublogo.png

Other


The section headings are made this way to make it easier to reference individual rules by number, like https://wiki.roll20.net/Sheet_Mistakes#5

Common Mistakes

A list of common mistakes made by both old and new sheet creators/authors.

[edit] 1

[edit] 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.

[edit] 2

[edit] The Preview Panel is not 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.

Ideally, use the Sheet Sandbox for sheet development.

[edit] 3

[edit] 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.

Otherwise the sheet will look like most of the CSS is gone, and the result is often basically unusable.

[edit] 4

[edit] (Legacy Sheet)Forgetting to add sheet- to the class names in your .css file.

This is not needed in the .html file, Roll20 automatically assumes all classes have that prefix there.(Doesn't apply to CSE sheets) See CSS Styling

[edit] 5

[edit] 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">

[edit] 6

[edit] 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.

[edit] 7

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

[edit] 8

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

[edit] 9

[edit] 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 were created before this rule against <table> was made.

[edit] 10

[edit] Forgetting about translation files

Forgetting to use or update translation files will result in the data-i18n attribute from the html to show as red like
[strength]
to indicate the translation is missing. If the sheet needs the translation file, and you don't copy it to your game, all/most text on it will show red text and the name of the language tag for each section, as seen in the example here.

[edit] 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.

[edit] G-1

[edit] 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"

[edit] G-2

[edit] 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.

Especially older sheet might be worse than newer sheets, as they have been created before later updates to the roll20 sheet framework(CSE), as well as predate newer features of HTML/CSS/JS, such as CSS Grid/Flexbox. If a sheet haven't been updated in several years, there is guaranteed to exist a newer, better made sheet, which would better a better example/template.

[edit] G-3

[edit] 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.


[edit] Related Pages

Retrieved from "https://wiki.roll20.net/index.php?title=Character_Sheet_Development/Common_Mistakes&oldid=33359"