Wiki Basics (or What's all this, then?)

Modified on 2018/05/09 07:00 by Jeff Joslin Categorized as Help, System
''Original author: Joe Wells''

Welcome to the wonderful VintageMachinery Wiki! All hail the great and powerful Wiki!

So, if you're reading this you're probably asking yourself "Self, just how can I contribute to this wonderful font of knowledge?" Well, Bunky, I'm glad you asked.

{toc}

===Create an Account===
The very first thing that you'll need is an Account for the Wiki. Yes, I know you already have an account for VintageMachinery.org and another for owwm.org. Maybe one day the stars will align and you'll only need one account for the whole VintageMachinery/OWWM world. But that day isn't today. Sorry.

To get your free / no obligation / newly minted Account, simply click on Create Account in the Navigation box over on the left-hand side of your browser. You will be asked a couple of painless questions and your Account will be created. You can use the same username and password that you use elsewhere in the VintageMachinery/OWWM metroplex.

With your spiffy new Account, you're now free to run roughshod throughout the Wiki. Don't worry; inadvertent, incorrect, or malicious edits can be rolled back, so there's little actual damage that you can do. But do take care, you really do have the power to change most anything in the Wiki at this point.

===Basic Formatting===
Entering text into the Wiki is as easy as typing, but making it look the way you want takes a bit more effort.

====Text Effects====
Adding text effects such as Bold or Italics involves marking the start and end of the text as shown below. Don't tell anyone, but I swiped this from the Wiki's [WikiMarkup-Reference|Help - WikiMarkup Reference] page:

* Writing {{<nowiki>'''bold'''</nowiki>}} produces '''bold'''
* Writing {{<nowiki>''italic''</nowiki>}} produces ''italic''
* Writing {{<nowiki>__underlined__</nowiki>}} produces __underlined__
* Writing {{<nowiki>--striked--</nowiki>}} produces --striked--
* You can use any combination, for example {{<nowiki>--striked '' '''bold''' and italic''--</nowiki>}} produces --striked '' '''bold''' and italic''--

Note that the tic marks are single quotes (') next to your Enter key rather than the accent mark (`) up next to your 1 key.

You can also add formatting by selecting the text that you wish to change and clicking the appropriate button on the Toolbar. Buttons 1, 2, 3, and 4 are Bold, Italics, Underline, and Strikethrough respectively.

[image|Format Toolbar|{UP}Toolbar.png]

====Whitespace and Carriage Returns====
Please be aware that the Wiki software has its own ideas about how to handle Enters, Line Feeds, Carriage Returns, and whitespace. In short, the Wiki will ignore a single Enter/Carriage Return at the end of a line unless the next line is blank. So if you type this:

{{{{This is a test.
This is also a test.}}}}

You'll see this:

This is a test.
This is also a test.

If what you're after is to make a list, please see below. But if you really, really want / need individual lines without whitespace between, you can add the Wiki tag <nowiki>{BR}</nowiki> to the end of each line (or click on button 19 / paragraph symbol on the Toolbar).

{{{{<nowiki>This is a test.{BR}
This is also a test.</nowiki>}}}}

This is a test.{BR}
This is also a test.

Also, the Wiki will strip out multiple spaces, leaving only one space between each word or sentence. So this:

{{{{This is a test.    This is also a test.}}}}

Turns into this:

This is a test.    This is also a test.

===Links, Files, and Images===
In order to turn your little slice of the Wiki into a multimedia sensation, you're going to need to know how to add links and images into your Pages.

====Links====
To link to a page within the Wiki, enclose the Page name within <nowiki>[]</nowiki> like so:

{{{{<nowiki>[MainPage]</nowiki>}}}}

[MainPage]

This needs to be the Wiki Page name, which is not necessarily the same as its Title. The Wiki Page name appears when Editing that Page. You'll see it in big letters at the top, Edit Page: PageName.

You can also add additional text to the link:

{{{{<nowiki>[MainPage|This is the Main Page]</nowiki>}}}}

[MainPage|This is the Main Page]

Linking to a page outside of the Wiki works much the same way:

{{{{<nowiki>[http://VintageMachinery.org/photoindex/detail.aspx?id=5631|Walker-Turner 5110 Lathe]</nowiki>}}}}

[http://VintageMachinery.org/photoindex/detail.aspx?id=5631|Walker-Turner 5110 Lathe]

====Uploading Files====
The images and other files used to create a Wiki Page should be stored within the Wiki. This prevents broken / dead links later on. [http://wiki.VintageMachinery.org/Upload.aspx|File Upload] over in the Navigation pane on the left side of your browser will take you to the Wiki's file storage area. If you're writing a new Page, create a New Directory to store the images, etc. for your masterpiece. Existing articles probably already have a directory.

Once your directory is created / located, click on it to open it. You'll see a list of its current contents (if any). To get your images there, click on Browse and find one of the files on your hard drive. Then click on Upload and it will be whisked away to Wiki-land forevermore. Note that there are no options for deleting or moving files, so please double-check what you're uploading and where you're uploading it to. If you get your wires crossed, you'll need to politely ask for assistance in the [http://www.owwm.org/viewforum.php?f=10|.com (Website) Support Forum].

Once you have a file uploaded, you'll notice that its name appears in the list of files along with its size. In addition, there is a Link column that will contain gobbledygook such as:

{{{{<nowiki>{UP}DeltaSerialNumbers%2fNewerDeltaSerialNumberTag.jpg</nowiki>}}}}

That gobbledygook is what you'll need to know to get your image to display in your Page.

====Images====
There are a few options for putting an image into a Page. The simple <nowiki>[image|Title|Link]</nowiki> will show the image without a border or caption. Putting the gobbledygook from the Link column noted above into this gives us:

{{{{<nowiki>[image|Title|{UP}DeltaSerialNumbers%2fNewerDeltaSerialNumberTag.jpg]</nowiki>}}}}

[image|Title|{UP}DeltaSerialNumbers%2fNewerDeltaSerialNumberTag.jpg]

<nowiki>[imageauto|Title|Link]</nowiki> displays the image with a border and a caption, like so:

{{{{<nowiki>[imageauto|Newer Delta Serial Number Tag|{UP}DeltaSerialNumbers%2fNewerDeltaSerialNumberTag.jpg]</nowiki>}}}}

[imageauto|Newer Delta Serial Number Tag|{UP}DeltaSerialNumbers%2fNewerDeltaSerialNumberTag.jpg]

Note that Title was used in the simple <nowiki>[image|Title|Link]</nowiki> version, even though the Title won't display. The Wiki software expects something to be there or it won't know what to do with it.

You aren't limited to uploading image files to the Wiki. If there is a .pdf, .doc, or other supported file that goes along with your Page, you can upload them as well. Supported file types are listed on the [http://wiki.VintageMachinery.org/Upload.aspx|File Upload] page. These additional file types won't "appear" in the Wiki Page as images do, but you can provide a Link to allow users to download the file. These links work similarly to the external links shown above:

{{{{<nowiki>[{UP}DeltaSerialNumbers%2fSerial%20Numbers%20For%20Milwaukee%20Bellfontaine%20and%20Tupelo%20Machines.pdf|Delta Serial Numbers .pdf]</nowiki>}}}}

[{UP}DeltaSerialNumbers%2fSerial%20Numbers%20For%20Milwaukee%20Bellfontaine%20and%20Tupelo%20Machines.pdf|Delta Serial Numbers .pdf]

===Additional Formatting===
Other formatting options generally used include Headings, Lists, and Tables.

====Headings====
Breaking a Page down into subsections can help with navigation and make the Page more readable. Headings are used to note these subsections.

A large heading could be used for major sections of a Page and are created like so:

{{{{===Big Heading===}}}}

===Big Heading===

Smaller headings, used for subsections, are also possible. These look like:

{{{{====Smaller Heading====}}}}

====Smaller Heading====

Headings don't need to have a blank line after them, you can put your text right on the next line.

{{{{====Smaller Heading====
My dog has fleas.}}}}

====Lists====
Lists are commonly needed in the sorts of Pages written for VintageMachinery. Here's how they work:

For a non-numbered list, simply add an asterisk / splat in front of each element of the list:

{{{{<nowiki>* A one
* And a two
** And a three</nowiki>}}}}

* A one
* And a two
** And a three

As you can see, multiple asterisks indent the list element.

Numbered lists work similarly, but use a pound sign rather than an asterisk.

{{{{<nowiki># A one
# And a two
## And a three</nowiki>}}}}

# A one
# And a two
## And a three

====Tables====
I'm not going to kid you, tables in a Wiki are kinda messy. So messy that they have their own Help page at [Tables|Help - Table Formatting]. Here are the basics to get you started.

To start a table, put <nowiki>{|</nowiki> on its own line. This will tell the Wiki software that what's coming next will be a table. Next, make a line like:
{{{{<nowiki>| Cell 1.1 || Cell 1.2</nowiki>}}}}
This will define the contents and layout of one row of the table. The line needs to start with | (pipeline symbol), then the contents of the first cell, then double || to note the next cell, then the contents of the next cell and so on. To separate rows, put <nowiki>|-</nowiki> on its own line. Once you have the table and its contents laid out, put <nowiki>|}</nowiki> on its own line at the bottom to tell the Wiki software that you're done with the table. Here's what a small table looks like all put together:

{{{{<nowiki>{|
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}</nowiki>}}}}

{|
| Cell 1.1 || Cell 1.2
|-
| Cell 2.1 || Cell 2.2
|}

===Creating a Page===
That "Create a new Page" link over in the Navigation box looks pretty inviting, doesn't it? You can use it if you'd like, but there's a pitfall that you should know about. People who visit the Wiki are only going to know about Pages that are listed on the Main Page. "Create a new Page" does not update the Main Page, so unless you go back and Edit the Main Page,  after creating your new Page, it could well get lost in Wiki limbo forever.

Instead, Edit the [MainPage] first. Go ahead, it won't bite. Decide what the Page Name and Title of your Page is going to be and add it in the appropriate subsection(s). You're creating a Link (just as above) to your Page in a List (just as above), so something like this: <nowiki>* [PageName|Title of the Page]</nowiki>.

Before:
{{{{<nowiki>===3.17 - Walker-Turner===
* [WTGeneralTimeline|Walker-Turner General Timeline]
* [PaintColorsWalkerTurner|Walker-Turner Paint Colors]</nowiki>}}}}

After:
{{{{<nowiki>===3.17 - Walker-Turner===
* [WTGeneralTimeline|Walker-Turner General Timeline]
* [PaintColorsWalkerTurner|Walker-Turner Paint Colors]
* [WTAdvertising|Walker-Turner Advertising Agencies: A Retrospective]</nowiki>}}}}

Once you have your new Link set up, click the Preview button to make sure that everything looks OK. If things are both hunky and dory, click on Save Item. The whole wide world can now see your changes.

But your new link doesn't look quite the same as the others. Don't worry, there's nothing wrong, you're just Linking to a Page that doesn't exist yet. Click on your new Link and you'll be told that the Page can't be found. There will be a link there to create the Page. Click it and you'll be brought to the "Create a new Page" dealie-bob with the PageName already filled in, based on the Link.

Start typin'.


===Wikifying a Forum Thread===
While writing down your own original VintageMachinery thoughts is fun and gratifying, sometimes a thread will pop up at the [http://www.owwm.org|OWWM Forum] that demands inclusion in the Wiki. When your now Wiki-trained eyes spot such a morsel, shoot a Private Message to the principal author to see if he plans to Wikify the info his own self. Weasel words like "Eventually", "I plan to", or "Someday" should be met with derision and a sneer. You just go on ahead and do the Wikification for them.

What we're after here is to create a single, cohesive article by that contains the relevant info from the thread. These threads are generally started by someone posting a procedure or other detailed information, then the thread progresses with clarifications, additions, and corrections. To pull that into the Wiki, copy over the main info, then modify it based on the additional info provided. Of course other sources can be used to further extend the info in the Page, including other Forum threads.

It's very important to pull any images used into the Wiki. You'll need to download each of these to your computer, then Upload from there.

Eric LaVelle's [HowToMakeLeatherBelts|How To Make Leather Belts] is an example of a Forum thread that was Wikified. The bulk of the text and images came from his initial post explaining his procedure. Additional info was pulled from other posts in that thread and inserted where it best seemed to fit.


Hopefully this info will get you on the path to Wiki-fu. There is much more to learn about the VintageMachinery Wiki and the options available. You'll learn more as you look at Pages that have already been written, as well as from the Wiki's [Help] Pages. If you need additional assistance, don't hesitate to ask questions in the [http://www.owwm.org/viewforum.php?f=10|.com (Website) Support Forum].


===If you really screw something up===
The standard user accounts let you create new pages and edit almost everything. There are some things that you cannot do, such as delete a page or file. If that becomes necessary, leave a message in the [http://owwm.org/viewforum.php?f=10|VintageMachinery.org Support forum] and an administrator will look after it. Be sure to provide a link to the relevant page or file, a description of what needs doing, and why.
Meta Keywords:
Meta Description:
Change Comment: De-categorized as "Electrical"
	Welcome Guest, • Login
Wiki Home \| VintageMachinery.org Home \| OWWM.org Home \| Donate	Search the Wiki: »