Oblivion Mod Wiki:Tutorials

From Oblivion Mod Wiki
(Redirected from Tutorials)
Jump to: navigation, search

Contents


[edit] Adding a Mod to the Wiki.

This guide will teach you how to add mods to the Wiki.

First off, you'll need to find the mod that you want to enter into the Wiki. It's generally best to find mods at the Official Forums. Mods that are released there usually have threads full of important and useful information.

Now that you've got a mod to enter in, you'll need to search for it. Just enter the mod's name into the search bar on the left, and hit "Go," and it should start searching. If there isn't a mod with that exact name in the Wiki, an entry will not show up. There should be something that says "Create this page," as shown here.

However, before going any further and adding that entry to the Wiki, be sure to also search for the author's name, in case the mod has already been added to the Wiki under a different name.

Now that you've made sure that the mod hasn't already been added to the Wiki, it's time to start actually adding the mod to the wiki. Hit "create this page." Now you should see an edit box.

Copy and paste this into that edit box.

{{mod
|author=
|threads=
|version=
|updated=
|requires=
|download=
}}

Now, we'll go over everything that you see above.

{{mod

|author=:This is where you'll put the author's name.

|threads=:This is where you'll put whatever forum threads you can find on this mod. If the mod is on The Elder Scrolls Nexus, be sure to check the "comments" box, there should be a "View them All" or a "Go to forum thread" link that you can click, that'll take you to the The Nexus Forums thread.

|version=:Here you'll put the latest version of the mod. If you can't find the version, just leave it blank, but please try to find the version number. If it's listed on The Elder Scrolls Nexus, ElricM, Planet Elder Scrolls, or pretty much of any of the "major" mod upload sites, it should have a version number listed. Check the file name as well, sometimes the version number is in it.

|updated=:The last time the mod was updated is what goes here. Again, if you can't find the date, just leave this blank. Although, if it's at any of the "major" mod sites, it should have a date. Most threads also have dates, just check the thread for an "This post has been edited by User: Date, Time." It's usually at the end of the post, in small letters. If that isn't there, then at the top of the post, there should be a posted date. Including the exact time is not needed, only Month, Day, Year.

|requires=:If the mod you're currently adding requires any other mods, programs, patches or the expansion, please put whatever it requires here.

|download=:Here is where you'll put all of the various download locations available.

Once you've filled all of this information out, you should have something that looks like this. (Depending on your mod.)

{{mod|author = bazz24
| threads = [http://www.bethsoft.com/bgsforums/index.php?showtopic=373085 
Bethesda Game Studios Forums]
| version = 1.0
| updated = April 14th, 2006
| requires=
| download= {{TESNexus|2935|The Elder
Scrolls Nexus}}
}}


[edit] Adding mods with more than one author

This is pretty much the same as what's done above, except, the template is a bit different. Here's what you'll copy.

{{mod|author1 =
| author2 =
| author3 =
| threads =
| version =
| updated =
| requires =
| download =
}}

[edit] Adding Tools

This is similar to adding a mod, you'll copy the following.

{{tool|author =
| threads =
| version =
| updated =
| requires=
| download=
}}

As you can see, the only difference to a mod (with one author) is the first line. When adding a new tool like this, it will be automatically listed in Tools.


[edit] Adding Categories

At the bottom of the page, add the mod to all the categories that the purpose of the mod covers. You can find the list of categories available on the Mods page.

If your mod requires buying a book or ring from a vendor to enable a spell that is required to enable functioning of your mod, like to teleport to your house mod that contains a bed and storage, don't include it in categoies like Items, Magic, or Merchants. Just add it to the category Homes.

[[Category:Homes]]

If your mod adds a set of retextured rings that contain a significant Armor Rating, and they are sold by a new merchant that also buys items from you, add it to categories Armor, Meshes and Textures, and Merchants. Cheats is a secondary category requiring entry into other primary categories.

[[Category:Armor]]
[[Category:Meshes and Textures]]
[[Category:Merchants]]
[[Category:Cheats]]


[edit] Adding Screenshots

First, upload your full-sized images by clicking the Upload file link in the toolbox on the left of the page. In the "Destination filename" box, begin with the name of the mod page followed by a description of the image. For example:

Destination filename: Monster_Madness-giant-troll.jpg


[edit] Adding Inline Images

To place an image on the right of the page, with explanatory text on its left, use the format:

[[image:DDS_Converter_2-1.jpg|right|400px|thumb|File Selection Window]]
File Selection Window

This area can be used for explaining what is depicted in the image on the right.

The size of the image can be specified as well as position relative to the text.
Using the HTML tag

<br clear="all" />

causes the text to continue below the inline image. These lines follow the image so as not to have following sections roll up and get mixed with the current one.

[edit] Adding a Gallery of Thumbnailed Screenshots

Here's a sample gallery and how it was specified on the page.

</PRE>

Note: The <center> and <small> tags indicate centered, smaller text (captions), not images.

The gallery will automaticall create linked thumbnail images with captions grouped into a table. Clicking on the thumbnail will go to an intermediate image that fits within a 800x600 sized preview with its description. Clicking on that intermediate image shows the full-resolution image.

For a more complete overview of images and formatting, see WikiMedia Help:Images and Wikipedia.

[edit] Designing a good mod/tool entry.

This "tutorial" will explain how to create a good mod entry. You should begin by following the appropriate tutorial above for starting to create the mod/tool entry. Once that is done, if you wish to create a full, well-designed entry, you should follow this tutorial. Of course, if you don't have the time to complete a full entry, even adding the basic information from the above templates would be helpful.

This information is meant to be used as a guideline. If you feel that adding something to or changing a mod entry would make the page better, then you should certainly go ahead and do it. Modders, especially, should feel free to do whatever they want (within reason) with their own mod pages. As Wikipedia says, one of its main goals is to "improve and maintain content," and if any of the rules prevent the improvement and maintenance of that content, ignore them.

[edit] Include

  1. The appropriate template from the above tutorials (mod, collab, or tool).
  2. Information about the mod.
    1. Description, overview, features, details of what the mod does, etc.
    2. Version history, unless the history is extremely large/long.
    3. Common problems, known issues, frequently asked questions, etc.
    4. Compatibility, conflicts, requirements, etc.
  3. Media
    1. Screenshots (gallery and/or "sideline" screenshot).
    2. Videos
    3. Sound or music clips
  4. Credits
  5. Reviews
  6. All the categories the mod's main content covers, at the bottom of the page

For examples of relatively well designed entries that are somewhat large, see Forestheart or Mighty Umbra. For examples of well designed, smaller entries, see Oblivion TESCS Icons or Kafei's MultiPierced Ears. As you can see, these entries are clear and concise in offering an overview of what the mod does.


[edit] Don't Include

  1. Installation and uninstallation information.
  2. Extremely large/long version histories.
  3. Extremely large/long, detailed explanations of mods.
  4. Personal commentary (except in reviews).
  5. Categories that aren't the main purpose of the mod, such as a book or ring that enables the main features.

For an example of a badly designed page, see OOO Archive. This page is a copy of the state of the OOO entry on July 2nd, 2007. As you can see, it is filled with huge amounts of information, is extremely unorganized, etc.

If you'd like some more tips on formatting, you can check the "Wiki Markup" page at Wikipedia, which is here.

One more thing, be sure to comment on what you're doing. To do that, down in the edit box, above "Save Page," you'll see a box with the word "Summary" next to it. Just enter in whatever you're doing, before you save the page. (For instance, if you're adding a new mod, just put in "New Mod.") This'll help out other editors when looking over the recent changes.

[edit] How to use discussion pages

Every "normal" page on the Oblivion Mod Wiki has a discussion page, also called a talk page. These pages can be accessed by clicking the "Talk" tab on the top toolbar, next to the "Article" tab. For example, the discussion page for this page is here. To learn when, why, and how to use these discussion pages, read the following sections of this tutorial.

[edit] Communicating with individuals

One use of discussion pages is to communicate with other users. If you need to talk to a Wiki user, find their User page. These are the pages titled User:Username. Again, click the Talk tab to access the discussion page. You can leave messages here for the user, and the Wiki will tell them they have a message. For information on how to format your messages and discussions, continue reading.

[edit] Discussing articles

Discussion pages can be used to hold discussions about the content of pages. If you want to discuss something about an article, click the [+] button next to the Talk tab. You will then be prompted for a discussion name. Try to choose a name that is both descriptive and concise. You can then begin the discussion by typing about what you want to discuss. You can discuss the content itself, the organization and formatting, etc. For information on how to format your messages and discussions, continue reading.

[edit] Discussion formatting

For the first comment in a discussion, just type your text normally. When you are finished typing your comment, please sign it with -~~~~. This code will automatically insert your username and the time and date you made the comment. Subsequent comments in the same discussion, regardless of who is making them, should be indented from the above comment. You can indent your comments with colons (:). For example, the second comment would require one indentation, which uses one colon. The third comment would then require 2 indentations, using two colons. Here is an example of a normal discussion.

This is the initial comment spawning the discussion. -~~~~
:This is the second comment, indented one time. -~~~~
::This is a third comment, indented twice. -~~~~
:::This is a fourth comment, indented three times. -~~~~

In some cases, if a discussion gets extremely long, with large amounts of indentation, you may notice the comments begin to get "squished" on the right side of the page. If you feel it is appropriate, you may wish to "outset" your comment by making a comment with no indentation. Additionally, if the discussion starts to split into multiple small discussions, it may be appropriate and useful to split the original discussion into multiple smaller discussions.

[edit] Mini-Templates

Here is a list of small templates that can be used to simplify some easy tasks. Instructions for their use can be found on their pages.

[edit] Delete

Place this template on pages that you feel should be deleted by an administrator. The syntax is simply {{Delete}}, and the template should be placed near the top of the page.

[edit] Discontinued

Use this template for mods/tools/programs that are discontinued and no longer updated and/or supported by their authors. The syntax is simply {{Discontinued}}, and should be placed near the top of the page.

[edit] Missing Links

Place this template on pages that are missing download links. The syntax is simply {{Missing Links}}, and the template should be placed near the top of the page.

[edit] Note

Use this template for making small, important notes. The syntax is {{note|note=note text}}.

[edit] Outdated

Use this template for mods/tools/programs that are outdated because they have been superseded, replaced, remade, etc. This template should also be used for compilations that include old versions of mods that have been since been updated. The syntax is {{Outdated|outdated=reason for being outdated}}, and this template should be placed near the top of the page.

[edit] Pulled

Place this template on mods that have been pulled offline by their authors. The syntax is simply {{Pulled}}, and the template should be placed near the top of the page. Note that this template includes the missing links template, so you do not need to use that template in addition to this one.

[edit] Race

Place this template in the requirements section of the mod template of any custom race mod that does not include its own custom race fix. The syntax is simply {{Race}}.

[edit] Rewrite

Place this template on pages that you feel need to be rewritten because they are unorganized, outdated, incorrect, verbose, etc. The syntax is {{rewrite|rewrite=reason for rewrite}}, and this template should be placed near the top of the page.

[edit] Warning

Use this template for making important warnings. The syntax is {{warning |warning=warning text }}.