View source for RL Wiki Readme

{{TOC}}
{{Parent|Main_Page|Main Page}}

== Wiki Boilerplate ==

At the beginning of each wiki page, we usually include some boilerplate material as follows:

{|class="wikitable"
!RL Templates || Result
|-
|'''Table of Contents'''<hr>
{{Code|<nowiki>{{TOC}}</nowiki>|Usage:}}
{{Marginalia|This template will always align to the right of the page.|Note:}}
|{{Single_Illustration|TOC_Example.png}}
|-
|'''Main Article'''<hr>
{{Code|<nowiki>{{Parent|Main_Page|Main Page}}</nowiki>|Usage:}}
|{{Parent|Main_Page|Main Page}}
|}

== Handling of Images ==

To prevent abuse of large image sizes, please resize all of your images before uploading it to the RL Wiki. Do not rely on resizing the images via the '''File:''' syntax.
In order to maintain image uniformity, we suggest the usage of some premade templates to serve all of your images:

{|class="wikitable"
!RL Templates || Result
|-
|'''Single Images'''<hr>
{{Code|<nowiki>{{Single_Illustration|Example.png|Worship the Doge!}}</nowiki>|Usage:}}
{{Marginalia|<nowiki>{{Single_Illustration|[1]|[2]|[3]}}</nowiki>
[1]Image file name.
[2]Caption
[3]Link (optional)
|Format:}}
|{{Single_Illustration|Example.png|Worship the Doge!}}
|-
|'''Duo Images'''<hr>
{{Code|
<nowiki>{{Duo_Illustration
|Example.png|Worship the Doge!|
|Example.png|Worship the Doge again!|
}}</nowiki>
|Usage:}}
|{{Duo_Illustration|Example.png|Worship the Doge!||Example.png|Worship the Doge again!|}}
|-
|'''Triple Images'''<hr>
{{Code|
<nowiki>{{Triple_Illustration
|Example.png|Worship the Doge!|
|Example.png|Worship the Doge again!|
|Example.png|Worship the Doge yet again!|
}}</nowiki>
|Usage:}}
|{{Triple_Illustration|Example.png|Worship the Doge!||Example.png|Worship the Doge again!||Example.png|Worship the Doge yet again!|}}
|-
|'''Quad Images'''<hr>
{{Code|
<nowiki>{{Quad_Illustration
|Example.png|Worship the Doge!|
|Example.png|Worship the Doge again!|
|Example.png|Worship the Doge yet again!|
|Example.png|You get the idea.|
}}</nowiki>
|Usage:}}
|{{Quad_Illustration|Example.png|Worship the Doge!||Example.png|Worship the Doge again!||Example.png|Worship the Doge yet again!||Example.png|You get the idea.}}
|-
|'''Text Blocks'''<hr>
{{Code|<nowiki>{{Text_Block|Worship the Doge!|200px}}
{{Single_Illustration|Example.png}}</nowiki>|Usage:}}
{{Marginalia|<nowiki>{{Text_Block|[1]|[2]}}</nowiki>
[1]Text.
[2]Block width in %, px, auto (default: 256px).
|Format:}}
|{{Text_Block|Worship the Doge!|200px}}{{Single_Illustration|Example.png}}
|}

== Text Formatting ==

You can use text formatting anywhere, including the caption space of images.

{|class="wikitable"
!RL Templates || Usage || Format || Result
|-
|'''Colors'''
|{{Code|<nowiki>
{{Color|Red|Red}}
{{Color|Green|Green}}
{{Color|Blue|Blue}}
</nowiki>}}
|{{Marginalia|<nowiki>{{Color|[0]|[1]}}
[0]Color value (default:"Blue").
[1]Text.</nowiki>}}
|{{Color|Red|Red}}{{Color|Green|Green}}{{Color|Blue|Blue}}
|-
|'''Wrong Examples'''
|{{Code|<nowiki>{{Wrong|Don't do it like this!}}</nowiki>}}
|{{Marginalia|<nowiki>{{Wrong|[0]}}
[0]Text message.</nowiki>}}
|{{Wrong|Don't do it like this!}}
|-
|'''Right Examples'''
|{{Code|<nowiki>{{Right|Please do it like this.}}</nowiki>}}
|{{Marginalia|<nowiki>{{Right|[0]}}
[0]Text message.</nowiki>}}
|{{Right|Please do it like this.}}
|-
|'''Notice Message'''
|{{Code|<nowiki>{{Notice|This very important message.}}</nowiki>}}
|{{Marginalia|<nowiki>{{Notice|[0]}}
[0]Text message.</nowiki>}}
|{{Notice|This very important message.}}
|-
|'''Code'''
|{{Code|<nowiki>{{Code|Use <nowiki> tags to prevent parsing.}}</nowiki>}}
|{{Marginalia|<nowiki>{{Code|[0]|[1]}}</nowiki>
[0]Code block. (should use <nowiki><nowiki>*</nowiki></nowiki>)
[1]Title (default: "Code:").}}
|{{Code|<nowiki>Use <nowiki> tags to prevent parsing.</nowiki>}}
|-
|'''Marginalia'''
|{{Code|<nowiki>{{Marginalia|Use <nowiki> tags to prevent parsing.|Hint:}}</nowiki>}}
|{{Marginalia|<nowiki>{{Marginalia|[0]|[1]}}
[0]Description block.</nowiki>
[1]Title (optional)}}
|{{Marginalia|<nowiki>Use <nowiki> tags to prevent parsing.</nowiki>|Hint:}}
|-
|'''Incomplete'''
|{{Code|<nowiki>{{Incomplete|cell|I left it out intentionally}}</nowiki>}}
|{{Marginalia|<nowiki>{{Incomplete|[0]|[1]}}
[0]Section name or "part"</nowiki>
[1]Reason (default:"it's still under construction.")}}
|{{Incomplete|cell|I left it out intentionally.}}
|-
|'''Software Disclaimer'''
|{{Code|<nowiki>{{Disclaimer|Vaporware}}</nowiki>}}
|{{Marginalia|<nowiki>{{Disclaimer|[0]|[1]}}
[0]Software name (default:Software)</nowiki>
[1]Company name (default:Reallusion LLC)}}
|{{Disclaimer|Vaporware}}
|}