Difference between revisions of "Code highlighting"

From Second Life Wiki
Jump to navigation Jump to search
m (minor update and tweak)
Line 10: Line 10:
* <code>'''<nowiki><tt></nowiki>'''</code> - Fixed-width text. Used in generic scenarios, and when others are too restricting for whatever reason.
* <code>'''<nowiki><tt></nowiki>'''</code> - Fixed-width text. Used in generic scenarios, and when others are too restricting for whatever reason.
* <code>'''<nowiki><lsl></nowiki>'''</code> - Widely used on the [[LSL Portal]] and other LSL scripts that appear on-wiki.
* <code>'''<nowiki><lsl></nowiki>'''</code> - Widely used on the [[LSL Portal]] and other LSL scripts that appear on-wiki.
* <code>'''<nowiki><htmlstrict4></nowiki>'''</code> - Use this when you need to highlight HTML code snippets, such as for use with Shared Media.
* <code>'''<nowiki><html4strict></nowiki>'''</code> - Use this when you need to highlight HTML code snippets, such as for use with Shared Media.
* <code>'''<nowiki><code></nowiki>'''</code> - Used not just for simpler, single-line code, but user input that needs highlighting, [[Style_Guide#Files.2C_paths.2C_URLs.2C_code.2C_and_other_typed_user_input|as described in the Knowledge Base Style Guide]].
* <code>'''<nowiki><code></nowiki>'''</code> - Used not just for simpler, single-line code, but user input that needs highlighting, [[Style_Guide#Files.2C_paths.2C_URLs.2C_code.2C_and_other_typed_user_input|as described in the Knowledge Base Style Guide]].


Line 23: Line 23:
* '''[[Shared Media wrapper]]''' - Torley Linden learned from Khepri Contractor that the <code><nowiki><html4strict></nowiki></code> tag works.
* '''[[Shared Media wrapper]]''' - Torley Linden learned from Khepri Contractor that the <code><nowiki><html4strict></nowiki></code> tag works.


== blogs.secondlife.com ==
== community.secondlife.com ==


While not as precise as the wiki, code can be called out on the forums and blogs, too. This is especially useful in the [http://blogs.secondlife.com/community/forums/scripting Scripting] and [http://blogs.secondlife.com/community/forums/scripting_library Scripting Library] forums where LSL scripts are shared.
Users of Grease Monkey (FireFox) and GreaseKit (Safari) (perhaps Google Chrome also) can install [http://userscripts.org/scripts/show/101223 LSL posting tool for community.secondlife.com] created by [[User:Cerise_Sorbet|Cerise Sorbet]] to get LSL highlighting on the forums. This is especially useful in the [http://community.secondlife.com/t5/LSL-Scripting/bd-p/LSLScripting Scripting] and [http://community.secondlife.com/t5/LSL-Scripting-Library/bd-p/LSLScriptingLibrary Scripting Library] forums where LSL scripts are shared.


When creating a post:
When creating a post:
 
# From the editing toolbar, click [[File:Insertcode.gif|link=]], then paste in your script
# From the editing toolbar, click '''>>''', then choose '''Syntax Highlighting''' > '''Plain'''.
# Press the (+ LSL) button that was added by the above script.
# Paste in your code.
 
[[File:Syntax_Highlighting_-_Plain.png|640px]]
 
Or, if your code has already been pasted, highlight the snippet and choose '''Plain'''.
 
This doesn't colorize code (as it appears in the inworld script editor) but does isolate it and preserves line breaks.

Revision as of 12:18, 19 April 2011

wiki.secondlife.com

If you're creating pages on this wiki that include external code examples (like LSL or HTML), it's highly useful to enclose the code between tags that retain formatting and other desirable attributes, like colorized syntax.

Tags

These tags are actively being used.

  • <tt> - Fixed-width text. Used in generic scenarios, and when others are too restricting for whatever reason.
  • <lsl> - Widely used on the LSL Portal and other LSL scripts that appear on-wiki.
  • <html4strict> - Use this when you need to highlight HTML code snippets, such as for use with Shared Media.
  • <code> - Used not just for simpler, single-line code, but user input that needs highlighting, as described in the Knowledge Base Style Guide.

For more tags, see the Parser extension tags on Special:Version. Some tags are possible because of GeSHiHighlight.

Examples

These pages use code highlighting tags extensively.

  • Category:LSL Library - Click a script page to see how it appears with the <lsl> tag.
  • Shared Media LSL Recipes - Becky Pippen mentioned a limitation of the <lsl> tags: namely, you seemingly can't highlight code inside, so she's using <tt> instead.
  • Shared Media wrapper - Torley Linden learned from Khepri Contractor that the <html4strict> tag works.

community.secondlife.com

Users of Grease Monkey (FireFox) and GreaseKit (Safari) (perhaps Google Chrome also) can install LSL posting tool for community.secondlife.com created by Cerise Sorbet to get LSL highlighting on the forums. This is especially useful in the Scripting and Scripting Library forums where LSL scripts are shared.

When creating a post:

  1. From the editing toolbar, click Insertcode.gif, then paste in your script
  2. Press the (+ LSL) button that was added by the above script.
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Code_highlighting&oldid=1141129"