Template talk:BSLjunc: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The template is in itself not a bad idea, although the relative placement of the name/type/value and the respective fonts/colors can perhaps be improved for clarity (if it's all black and has the same typesetting, then the eye doesn't easily jump to the right information, even for someone who actually looks at these boxes rather than at the surrounding text, and knows what they're all about). | The template is in itself not a bad idea, although the relative placement of the name/type/value and the respective fonts/colors can perhaps be improved for clarity (if it's all black and has the same typesetting, then the eye doesn't easily jump to the right information, even for someone who actually looks at these boxes rather than at the surrounding text, and knows what they're all about). | ||
A bigger issue is the space that it takes up. The one-line display such as <code>chr_dontaim [ai_name:string | script_id:int] on_off:int{0 | 1}</code> may not be appealing to Generation 2.0, but it fits on one line and does not break the flow of a page that supposedly contains some non-trivial scripting wisdom. Therefore, like in a coding textbook, an effort must be made to make those insets unobtrusive, less in-your-face if you will. A good (counter)example is [[BSL:AI_activity]] as it appears currently. Each section has some text about the meaning and effect of a group of commands, but before the text there's a list of the commands about to be described, and that "list" takes the form of an ill-shaped | A bigger issue is the space that it takes up. The one-line display such as <code>chr_dontaim [ai_name:string | script_id:int] on_off:int{0 | 1}</code> may not be appealing to Generation 2.0, but it fits on one line and does not break the flow of a page that supposedly contains some non-trivial scripting wisdom. Therefore, like in a coding textbook, an effort must be made to make those insets unobtrusive, less in-your-face if you will. A good (counter)example is [[BSL:AI_activity]] as it appears currently. Each section has some text about the meaning and effect of a group of commands, but before the text there's a list of the commands about to be described, and that "list" takes the form of an ill-shaped cluster of boxes that are not hidden by default (can't be hidden at all, for that matter), take up more space than the explanatory text, and remain very distracting while reading the text. | ||
If this template is modified to be less obtrusive/invasive of a pages's content, I can use it in tutorials; if not, I will use regular typesetting like in [[BSL:Frustum_and_fog]] | If this template is modified to be less obtrusive/invasive of a pages's content, I can use it in tutorials; if not, I will use regular typesetting like in [[BSL:Frustum_and_fog]] | ||
:For example, this template, when transcluded, can display just the name of the variable or function in a monospace font, distinguishing between variables and functions either through a color scheme or through the use of parentheses, e.g., '''<code>am_invert</code>''' can imply a variable, whereas '''<code>ai2_passive(...)</code>''' can imply a function, even if in this context actual arguments for <tt>ai2_passive</tt> are not listed. Placing the mouse over that "code snippet" would call up a hoverbox with the full information about the signature and default values. | :For example, this template, when transcluded, can display just the name of the variable or function in a monospace font, distinguishing between variables and functions either through a color scheme or through the use of parentheses, e.g., '''<code>am_invert</code>''' can imply a variable, whereas '''<code>ai2_passive(...)</code>''' can imply a function, even if in this context actual arguments for <tt>ai2_passive</tt> are not listed. Placing the mouse over that "code snippet" would call up a hoverbox with the full information about the signature and default values. | ||
::[[User:Geyser|geyser]] ([[User talk:Geyser|talk]]) 11:26, 9 February 2018 (CET) | ::[[User:Geyser|geyser]] ([[User talk:Geyser|talk]]) 11:26, 9 February 2018 (CET) | ||
Revision as of 13:58, 9 February 2018
The template is in itself not a bad idea, although the relative placement of the name/type/value and the respective fonts/colors can perhaps be improved for clarity (if it's all black and has the same typesetting, then the eye doesn't easily jump to the right information, even for someone who actually looks at these boxes rather than at the surrounding text, and knows what they're all about).
A bigger issue is the space that it takes up. The one-line display such as chr_dontaim [ai_name:string | script_id:int] on_off:int{0 | 1} may not be appealing to Generation 2.0, but it fits on one line and does not break the flow of a page that supposedly contains some non-trivial scripting wisdom. Therefore, like in a coding textbook, an effort must be made to make those insets unobtrusive, less in-your-face if you will. A good (counter)example is BSL:AI_activity as it appears currently. Each section has some text about the meaning and effect of a group of commands, but before the text there's a list of the commands about to be described, and that "list" takes the form of an ill-shaped cluster of boxes that are not hidden by default (can't be hidden at all, for that matter), take up more space than the explanatory text, and remain very distracting while reading the text.
If this template is modified to be less obtrusive/invasive of a pages's content, I can use it in tutorials; if not, I will use regular typesetting like in BSL:Frustum_and_fog
- For example, this template, when transcluded, can display just the name of the variable or function in a monospace font, distinguishing between variables and functions either through a color scheme or through the use of parentheses, e.g.,
am_invertcan imply a variable, whereasai2_passive(...)can imply a function, even if in this context actual arguments for ai2_passive are not listed. Placing the mouse over that "code snippet" would call up a hoverbox with the full information about the signature and default values.