Difference between revisions of "RL Wiki Readme"

From Reallusion Wiki!
Jump to: navigation, search
m (Text Formatting)
m (Wiki Boilerplate)
 
(2 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
{{Code|<nowiki>{{Parent|Main_Page|Main Page}}</nowiki>|Usage:}}
 
{{Code|<nowiki>{{Parent|Main_Page|Main Page}}</nowiki>|Usage:}}
 
|{{Parent|Main_Page|Main Page}}
 
|{{Parent|Main_Page|Main Page}}
 +
|-
 +
|'''Article'''<hr>
 +
{{Code|<nowiki>{{Article|Wiki_Page|Page Name}}</nowiki>|Usage:}}
 +
|{{Article|Main_Page|Main Page}}
 
|}
 
|}
  

Latest revision as of 23:12, 3 January 2019

Main article: Main Page.

Wiki Boilerplate

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

RL Templates Result
Table of Contents
Usage:
{{TOC}}
Note:
This template will always align to the right of the page.
TOC Example.png
Main Article
Usage:
{{Parent|Main_Page|Main Page}}
Main article: Main Page.
Article
Usage:
{{Article|Wiki_Page|Page Name}}
Article: 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:

RL Templates Result
Single Images
Usage:
{{Single_Illustration|Example.png|Worship the Doge!}}
Format:
{{Single_Illustration|[1]|[2]|[3]}}
[1]Image file name.
[2]Caption
[3]Link (optional)
Worship the Doge!
Duo Images
Usage:
{{Duo_Illustration
|Example.png|Worship the Doge!|
|Example.png|Worship the Doge again!|
}}
  • Worship the Doge!
  • Worship the Doge again!
Triple Images
Usage:
{{Triple_Illustration
|Example.png|Worship the Doge!|
|Example.png|Worship the Doge again!|
|Example.png|Worship the Doge yet again!|
}}
  • Worship the Doge!
  • Worship the Doge again!
  • Worship the Doge yet again!
Quad Images
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.|
}}
  • Worship the Doge!
  • Worship the Doge again!
  • Worship the Doge yet again!
  • You get the idea.
Text Blocks
Usage:
{{Text_Block|Worship the Doge!|200px}}
{{Single_Illustration|Example.png}}
Format:
{{Text_Block|[1]|[2]}}
[1]Text.
[2]Block width in %, px, auto (default: 256px).
Worship the Doge!
Example.png

Text Formatting

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

RL Templates Usage Format Result
Colors Code:
{{Color|Red|Red}}
{{Color|Green|Green}}
{{Color|Blue|Blue}}

{{Color|[0]|[1]}}
[0]Color value (default:"Blue").
[1]Text.
RedGreenBlue
Wrong Examples Code:
{{Wrong|Don't do it like this!}}

{{Wrong|[0]}}
[0]Text message.
✘ Wrong: Don't do it like this!
Right Examples Code:
{{Right|Please do it like this.}}

{{Right|[0]}}
[0]Text message.
✔ Right: Please do it like this.
Notice Message Code:
{{Notice|This very important message.}}

{{Notice|[0]}}
[0]Text message.
⚠ This very important message.
Code Code:
{{Code|Use <nowiki> tags to prevent parsing.}}

{{Code|[0]|[1]}}
[0]Code block. (should use <nowiki>*</nowiki>)
[1]Title (default: "Code:").
Code:
Use <nowiki> tags to prevent parsing.
Marginalia Code:
{{Marginalia|Use <nowiki> tags to prevent parsing.|Hint:}}

{{Marginalia|[0]|[1]}}
[0]Description block.
[1]Title (optional)
Hint:
Use <nowiki> tags to prevent parsing.
Incomplete Code:
{{Incomplete|cell|I left it out intentionally}}

{{Incomplete|[0]|[1]}}
[0]Section name or "part"
[1]Reason (default:"it's still under construction.")
! This cell is incomplete because I left it out intentionally.
Software Disclaimer Code:
{{Disclaimer|Vaporware}}

{{Disclaimer|[0]|[1]}}
[0]Software name (default:Software)
[1]Company name (default:Reallusion LLC)

By installing Vaporware you have agreed to Reallusion LLC's software disclaimer:

This Vaporware is provided by Reallusion LLC "as is" and "with all faults." Reallusion LLC makes no representations or warranties of any kind concerning the safety, suitability, lack of viruses, inaccuracies, typographical errors, or other harmful components of this Vaporware. There are inherent dangers in the use of any software, and you are solely responsible for determining whether this Vaporware is compatible with your equipment and other software installed on your equipment. You are also solely responsible for the protection of your equipment and backup of your data, and Reallusion LLC will not be liable for any damages you may suffer in connection with using, modifying, or distributing this Vaporware.