Contributor Guides

From TS3wiki

This page covers the guidelines for contributors with code examples.

Sims 3 Intro:

<div class="intro">
Put in here a short descriptive text explaining what the page is about.
</div>

Workshop Intro:

<div class="intro wsintro">
Put in here a short descriptive text explaining what the page is about.
</div>


Contents

Layout guidelines

  • Reserve the H1 (=) for the page title only (automatically set).
  • Use H2 (==) for the main page titles. H3, H4, H5 and H6 for any subtitles in that order.
  • All headers have a top padding added so no need for blankspace/stroke before those.
  • Always put the table of content straight after the H1 header, no exceptions.

Current Category Structure

To put a page into an existing Category put the following code at the very bottom of the page:

[[Category:NAME]]

You can cut and paste from the sample codes below for speed and accuracy if you like. You only need to use the lowest level category code, not the ones above, so for example, if you create a page dedicated to the Logic Skill you only need use [[Category:Skills]]

The Sims 3 Game

Reference Guides

Category Code
Reference Guides[[Category:Reference_Guides]]

Expansion Packs

Category Code
World Adventures[[Category:World_Adventures]]

TSR Workshop

Category Code
Documentation[[Category:Documentation]]
Technical References[[Category:Technical_References]]
Textures[[Category:Textures]]

Forwarding

If you think people might be looking for, say, Bugs under I for Insects, then you could create a page called "Insects" and put a redirect in there to the bugs page. This is the code you put in that new page:

#REDIRECT [[pagename]]


Tables

Table Basics

When editing tables, do not set any height or width values on the table or td. If you want td's to be the same width in tables placed in a row, use a % value on the td's. Make sure they always add up to 100. See reference page below for example.

Use this page as a reference for layout: Books Guide

  • For table headers you use !
  • For table columns you use |
  • For table rows you use |-
  • To add additional columns or headers add || or !! inbetween each, for instance: !Title!!Title2 or |Column text||Column text
  • To add width to a header or column add width="X%"| right after the ! or | - Just make sure all your % figures add up to 100%

Basic table code example:

{|
!width="50%"|Table Header 1!!width="25%"|Table Header 2!!width="25%"|Table Header
|-
| Table Column 1 || Table Column 2 || Table Column 3
|-
| Table Column 1 || Table Column 2 || Table Column 3
|-
| Table Column 1 || Table Column 2 || Table Column 3
|}

This would render like this:

Table Header 1Table Header 2Table Header
Table Column 1 Table Column 2 Table Column 3
Table Column 1 Table Column 2 Table Column 3
Table Column 1 Table Column 2 Table Column 3

Tables Advanced

You can add sort option on top of wiki tables with a special class. Here's an example:

NameSurnameHeight
JohnSmith1.85
RonRay1.89
MarioBianchi1.72

The code you would use is:

{|class="wikitable sortable"
!Name!!Surname!!Height
|-
|John||Smith||1.85
|-
|Ron||Ray||1.89
|-
|Mario||Bianchi||1.72
|}

Paragraphs under tables

For paragraphs underneath a table without a header (like this one), you need to add a blank space in between the table and the paragraph, using this code:

<br class="clear" />

Example of this:

Title 1 Title 2
This will go in the first ColumnThis will go in the second column


A paragraph goes here under the table. Notice how the added breakline makes sure there's good whitespace.

Headers under tables

All headers have padding added on top so you do not need any extra blankspace added if you start with a header under a table. This applies to all headers.

Example of this:

Title 1 Title 2
This will go in the first ColumnThis will go in the second column

Header under table example

As you can see whitespace is added without the need of an additional breakline.

Images

Images should ALWAYS be aligned to the right

All images in a page should be aligned right for readability (left to right) and consistency throughout the page.

Clear your images whenever you start a new paragraph or header that is not related to the image.

If you have a large image and want it full wiki width, make the thumbnail exactly 740px wide. The wiki page width is 750px but the thumbnail border is 5px large.

Bullets next to images

  • This works fine since the image is floated right

Headers next to images

Only use this if the header is related to the image, otherwise you clear the image first.

Code Example:

[[File:Image source here|thumb|Caption here|right]]
Write your text here.
<br class="clear />

Bullet lists

Use bullets to emphasize for instance a list of links, commands or anything else that is presented in list form.

  • Bullet item 1
  • Bullet item 2
  • Bullet item 3

Code Example:

*Bullet item 1
*Bullet item 2
*Bullet item 3

Special Info Boxes

There are special info boxes you can use for Tips, Cheats and Warnings.

Did you know

You can replace this text with your own to create a Did you know section? If you decide to copy this code, please keep the width, alignment and the didyouknow.png in order for this to display correctly

And this is how it's done:

<div class="dyk">
<p class="header">Did you know</p>
You can replace this text with your own.
</div>


You can also use this box:

Warning style added!

If you want to add a warning or a "Hey you need to read this" kind of thing, use this new style.

<div class="warning">
<p class="header">Warning style added!</p>
If you want to add a warning or a "Hey you need to read this" kind of thing, use this new style.
</div>

or for the bottom of the page to link out to similar content:

<div class="yml">
<p class="header">You may also like:</p>
[[Reviewer_Guide]], [[Reviewer_Guide]], [[Reviewer_Guide]]
</div>


This is for the very bottom of the page, and should be the last bit of text in your article. Add your page to a category, using the code below:

For Sims 3:

[[Category:Reference_Guides]]

For Workshop:

[[Category:TSR Workshop]]
Personal tools
TSR Workshop
Powered by MediaWiki