Difference between revisions of "Wiki Help"

Revision as of 18:19, 18 January 2017

This section is in progress by @bot.

So you want to contribute to the wiki? Welcome!

FamiLAB is an ever-growing and changing community. Our space adds new tools and new classes all the time, and walking into those changes can be a little overwhelming. That's why it's important to keep our Wiki up to date.

This page includes an overview of Wiki style syntax (all the weird, nonintuitive symbols you have to use to make it readable), as well as tips on writing your content.

Gathering information

Help article organization

For the sake of simplicity, we're going to refer to most Wiki pages as 'Help Articles'. For the most part, Wiki pages are basically Standard Operating Procedures (SOPs) for the Lab.

Here is a suggested structure to start your document. You can copy and paste this if you like:

__TOC__
==Overview==
<!--A description of the tool/process/procedure. Keep it about 3-5 sentences. -->
==Get Started==
<!--A basic tutorial so the user is comfortable COMPLETING a task. -->
<!--If this is a more advanced doc, this section can be titled ==Procedure==-->
===Summary=== 
<!--Ex. "We are going to use the Thingajig5000 MicroMagicator to make a basic sparkle amulet. This process takes about 15 minutes to prepare, 20 minutes to execute, and 5 minutes to clean up."-->
===Definitions===
<!--If a user may not know what 'thermbibulate' means, define it here.-->
'''Thermbibulate''' - to gently agitate a solution of 50% wonderflonium and 50% Sprite Remix; used to rapidly heat theoretical matter.
===Cautions===
<!--Describe things that could damage a tool or ruin the product of a procedure. Explain how to avoid them.-->
===Warnings===
<!--Describe things that CAN KILL OR MAIM YOU. Explain how to avoid them.
===Qualifications===
<!--If a machine needs prerequisite knowledge, ex. GCode or an introductory class, say so. Provide resources here.-->
===Equipment and Supplies===
<!-- List materials for the project, rags for cleaning, hair spray for 3D printing, anything along those lines. -->
===Procedure===
<!-- Use numbered steps in this section. Keep commands simple.-->
==Feedback and Assistance==
<!-- Link to the experts. Who do I call if I break something? Who do I call if I don't know how to fix the thing I made?-->
==References==
<!--Helpful links and related Wiki pages-->

Feel free to organize documents in whatever way makes sense, but try to use a structure that is easy for other members to update.

Wiki syntax

Headings & Structure

Surround headings with equals signs ( = ), starting with 2 equals signs for the highest level header.

==Header 1==
===Header 2===
====Header 3====

Bold/Italics

Use apostrophes to change font weight and style. HTML tags are also recognized by Wiki markup.

Use 2 apostrophes to italicize. Use 3 apostrophes to make text bold.

''Italics''
'''bold'''
<i>italics</i>
<b>bold</b>

Lists

Links

Enclose external links in single brackets. Type the URL, a space, and then the hyperlink text after the URL.

 [https://familab.org/ FamiLAB.org] 

Images

Tables

Resources

Thanks to User:LloydBlack Lloyd for gathering this great list of Wiki resources!

• Wikipedia-Help:Cheatsheet - Brief guide to wiki markup.
• Wikipedia-Help:Wiki markup - Wiki markup language.
• MediaWiki-Help:Formatting - Help with formatting wiki pages.
• MediaWiki-Help:Tables - Table markup for adding tables to wiki pages.
• MediaWiki Tables Generator - Wizard for making basic wiki tables.

Editing for usability