From DLXS Documentation

Revision as of 16:10, 30 July 2008

Using the DLXS Documentation wikis

• See Using_the_DLXS_Wiki for instructions on obtaining editing privileges.
• We encourage edits and contributions from DLXS members! See the Custom Styles section for styles designed specifically for use by DLXS members.

Basic Navigation

Upper right navigation bar

• Username: This is your User page, where you can put personal information about yourself.

• my talk: This is your Talk page, to be used for carrying on conversations with other users on the Wiki. If someone edits your talk page, you'll receive a notification then next time you login to the wiki.

• my preferences: here you can set many preferences, such as personal info, date & time formats, skins, editing preferences, etc.

• my watchlist: changes to pages you've marked as 'watch' (see below)

• my contributions: lists edits you've made to the wiki

• log out: logs you out

Left-hand Navigation

• navigation
  • Main Page: Takes you to the Wiki's main page
  • Recent Changes: Shows the most recent changes to the Wiki
  • Random Page: Do you feel lucky?
  • Help: Links to a help page specific to that Wiki

• search
  • Go—the default—will take you directly to a page if it exactly matches your search, otherwise it does a regular search:
  • Search searches for your text, with page title matches coming first

• toolbox
  • What Links Here shows which other pages on the Wiki point to the one you are currently on
  • Special Pages lists the various special pages of the Wiki, including Most linked to pages, Orphaned pages (pages without any incoming links), File list, Wanted pages, and many others.

Article Tabs

The tabs at the top of the article allow you to interact with the page:

• article - shows you the current version of the article
• discussion - a discussion page for this article. This is where editors will talk about what should or should not be in a particular article. (Can sometimes make for fascinating reading, esp. on WikiPedia)
• edit - click this to edit the content of an article (see below)
• history - shows in reverse chronological order the edits made to a page. From here you can see past versions of the page, and compare versions to see where the changes were made
• move - changes the name of an article (and therefore it's URL/location). A redirect is normally created to link the old location to the new
• watch adds an article to your watchlist

Basic Wiki Editing & Formatting

Practicing Editing

Create a Sandbox page for yourself at User:Uniqname/Sandbox. You can use this Sandbox to play around with editing pages and not bother anyone.

Try creating headers, formatting texts, creating lists and linking to other pages.

Creating New Pages

There are many ways to create new pages. A few of the most common are:

• If you see a red link, that signifies that the article has not been made yet. Simply click on the red link, and it will direct you to an Edit page. From there, you can type up whatever information you please.

• If you search for a page that doesn't exist, there will be a link to create that page.

• Begin by editing a current page and enter the markup to link to the page you want to create. [[Name of page]]. Save the current page and then click on the red link to go directly to the edit mode of the new page.

Note that page/file names for MediaWiki are caps-sensitive, so Mlibrary is a different page from MLibrary. Also, all pages must start with a capital letter. For consistency, major words in all page titles should be in capital letters.

Editing Wikis

To edit a page, click on the edit link in the top navigation. Alternately, to edit just a secion of a page, click on the edit link over to the right of the section heading.

Saving Your Changes

At the bottom of the edit page, you'll have the following options:

• Use the Summary: field to indicate the changes you've made.

• Check the This is a minor edit box to indicate that the edit is minor, e.g. a spelling or punctuation correction.

• It is highly recommended that you use the Show preview button first so that you can look over your changes to make sure you haven't made any formatting mistakes. Then you can click the Save page button to save your changes.

Page Titles

For consistency, major words in all page titles should be in capital letters.

Pages pertaining to specific classes should include that class in their page title. Ex. “Mounting the Collection Online” should be "Mounting the Text Class Collection Online."

Sections & Paragraphs

= Section =

== Sub-section ==

=== Sub-sub-section ===

==== Sub-sub-sub-section ====

Line one

Line two

Text Formatting

<ul>
  <li class="list">list item 1</li>
  <li class="list">list item 2</li>
</ul>

lorem 
     ipsum

Linking

Lists

* Item 1
** Item 1.1
** Item 1.2
* Item 2
** Item 2.1
*** Item 2.1.1
*** Item 2.1.2
*** Item 2.1.3
** Item 2.2
* Item 3

# Item 1
## Item 1.1
## Item 1.2
# Item 2
## Item 2.1
### Item 2.1.1
### Item 2.1.2
### Item 2.1.3
## Item 2.2
# Item 3

Tables

You can use wiki table formatting or html table formatting

<table cellpadding="5" cellspacing="0" border="1">
  <tr>
    <th>heading 1</th>
    <th>heading 2</th>
  </tr>
  <tr>
    <td>cell 1</td>
    <td>cell 2</td>
  </tr>
</table>

{| cellpadding="15" cellspacing="0" border="1"
|-
!heading 1
!heading 2
|-
|cell 1
|cell 2
|}

OR

{| cellpadding="15" cellspacing="0" border="1"
|-
!heading 1 !! heading 2
|-
|cell 1 || cell 2
|}

Images

DLXS wiki upload page

DLXS wiki list of uploaded images

Style	Markup	Example
Basic image w/custom alt text	[[Image:DLXSlogo.gif|The DLXS logo]]
Image w/custom alt text & floated to write	[[Image:DLXSlogo.gif|right|The DLXS logo]] Here is the DLXS logo floated to the right, if you put the image before the text, the text should wrap around it like this.	Here is the DLXS logo floated to the right, if you put the image before the text, the text should wrap around it like this.
Resize image	[[Image:DLXSlogo.gif|100px|The DLXS logo]]
Link directly to an image without displaying it:	[[:media:DLXSlogo.gif|Image of the DLXS logo]]	Image of the DLXS logo

Signing

Sometimes it is helpful to sign your name to your edits (DLXS_partener comments and talk pages). To add a "signature" (i.e. username and timestamp) use the following code.

--~~~~

turns into --suz 16:05, 30 July 2008 (EDT)

Using HTML

You can use most basic HTML code in your pages as well. However, it is considered to be good wiki form to use the Wiki mark-up language when it is available.

Hidden Comments

You can comment in the wiki the same way you would comment in html. Use when you want to leave comments that can only be seen when editing the page.

<!-- comment here -->

DLXS Custom Styles

Templates for page status

There are currently 2 templates that can be applied to any page to signal a page's status.

To assign a template to a page, enter the markup below to the top of the page.

{{WorkInProgress}} will display:

This page is a work in progress. It is actively being worked on.
So don't worry if it looks kinda weird.

{{NeedsReview}} will display:

This page has been flagged by DLXS or DLXS Users as needing to be reviewed.
Until it is fully reviewed, it may contain inaccurate or difficult to follow information.