Editing Guidelines

From LinuxLaptopWiki

The LinuxLaptopWiki uses the popular MediaWiki software, most well known from Wikipedia. You can find some general help on writing MediaWiki pages in Help:Editing.

To create a new page on this Wiki, first search for it in the search box in the toolbar to the left of every page. If no such page exists, you'll be given the option to create it.

[edit] Laptop Pages

Naming convention: Manufacturer Model (e.g. Sager NP451 or Dell Inspiron 500)

Below is a template you and copy and paste to create a new page, after editing as necessary. The most important part of the page is the component breakdown, shown in the 'General Status' section below. This involves a list of all the components in the laptop, what chipsets they use, and some wiki magic to make sure that any updates to a component will be reflected in the pages of all laptops that use them.

Write your brief introduction about the Laptop and your experiences here.

Manufacturer's page: http://manufacturer.com/products/model12.html

== General Status ==

{{hwheader}}
{{hw|Type of Component|Component Page|Optional Comment}}
{{hw|Webcam|ALi Corp M5602}}
{{hwfooter}}

== Model Specifics ==

=== Suspend to RAM ===

To get STR working on this model....

[[Category:Dell|Model Name]]

Notes:

1. Component Table
   1. The table begins with the wikicode {{hwheader}}, the header for hardware component table.
   2. You may then have any number of {{hw}} lines, with the format demonstrated above.
      1. The 'Component Page' refers to another page on the wiki, for that component, as explained below.
   3. You must end the table with the wikicode {{hwfooter}}.
2. Category
   1. In the last line you should replace 'Dell' with whoever manufactured the Laptop.
   2. Replace 'Model Name' with the Laptop's model name, this is used for the sort order in it's category.
   3. You can see which categories already exist here: Category:Manufacturers
   4. If you write the name of a Manufacturer which does not already exist, a category will be automatically created for it.

For an example of this template in use, see the Clevo D901C page.

[edit] Component Pages

Naming convention: Manufacturer Model/Type Type/Model (e.g. Z-Star Corp ZC0301 WebCam or Intel PRO/Wireless 2200BG)

Below is a template that you can copy and paste to a new component change, and make the necessary changes. Most important is the 'setdata' section at the end, look out for it.

== Status ==

Working.

Driver home: http://www.driver.com/

== How to check if this is your card ==

<pre>
# lsusb |grep 0402:5602
Bus 002 Device 025: ID 0402:5602 ALi Corp. Video Camera Controller
</pre>

For more general information on how to check what webcam you have, see [[:Category:Webcams]]

== Notes ==

# Any additional notes which may be useful

{{list of laptops using this hardware}}

{{hwstatus|Status text|Status color}}
[[Category:Webcams]]

Notes:

1. If you don't know how to check for the card, leave the section blank but with the heading intact.
2. Replace any occurance of "Webcam" with the correct category name.
3. hwstatus line
   1. Status text could be 'Working', 'Driver in development', 'No driver exists', or whatever you see fit.
   2. Status color could be 'lime' (green - working), 'yellow' (partially working), or 'red' (not working).
   3. e.g. {{hwstatus|Working|lime}} - this info is automatically used on pages for laptops using the component
4. Notes or sections on other info
   1. Add whatever you feel necessary... xorg.conf config for graphics cards, which software works with what options, etc.
5. The {{list of laptops using this hardware}} will be automatically replaced with an appropriate heading and the list of laptops that make use of the hardware listed on this page.

[edit] FAQs

Write any questions you have here.