Difference between revisions of "Help:Contents"

From Shehaqua Family Guidebook
Jump to: navigation, search
(Uploading Files: fixed links)
(Conventions: add subsections and expand programs)
Line 55: Line 55:
 
== Conventions ==
 
== Conventions ==
  
The purpose of the conventions in the Guidebook is to keep the information organized. Where the convention is intentionally vague, the exact method is left to the editor's discretion for what works best. If something is unclear, find some work done by the [[Operations Circle]] that is similar to what you are doing and copy the conventions.
+
The purpose of the conventions in the Guidebook is to keep the information organized. Where the convention is intentionally vague, the exact method is left to the editor's discretion for what works best. If something is unclear, find some work done by the [[Operations Circle]] that is similar to what you are doing and copy the layout.
  
One convention that is applied everywhere is that every longer page should start with a one-sentence abstract, followed by a paragraph-long introduction.
+
One convention that is applied everywhere is that every longer page should start with a one-sentence abstract as the first sentence in a paragraph-long introduction.
  
 
=== Organization of the Guidebook ===
 
=== Organization of the Guidebook ===
Line 63: Line 63:
 
There are three sections in the Guidebook
 
There are three sections in the Guidebook
  
The '''[[Assignments]]''' section contains information on how participants are to do the assignments (a.k.a. jobs) during the program. Each page in the assignments section should only have one assignment on it. The first sentence is the abstract that tells what the assignment is about.
+
The '''[[Assignments]]''' section contains information on how participants are to do the assignments (a.k.a. jobs) during the program.
  
The '''[[Programs]]''' section
+
The '''[[Programs]]''' section contains helpful informaton for the staff of each program.
  
The '''[[Shehaqua Circles]]''' section
+
The '''[[Shehaqua Circles]]''' section contains public information on each circle.
 +
 
 +
==== Assignments ====
 +
 
 +
Each page in the assignments section should only have one assignment on it and should be part of the Staff Descriptions category.
 +
 
 +
==== Programs ====
 +
 
 +
Examples of what might go on the Guidebook and not the website:
 +
* Typical budgets
 +
* Accepted interpretations of our policy
 +
* Local hotel information
 +
 
 +
Do not duplicate information that is available on the website. Information that belongs on the website include:
 +
* Directions
 +
* A tour or other description of the program aimed at newcomers
 +
* Fees and policy information
 +
 
 +
Certain information does not belong on either the Guidebook or the website include.
 +
* Discussions of any kind
 +
* Meeting agendas. Many Circles use Google Drive for this purpose.
 +
* Any document with personal details
 +
 
 +
==== Shehaqua Circles ====
 +
 
 +
Each circle has a page in the Shehaqua Circles section to

Revision as of 22:11, 13 December 2013

This page is a quick introduction to editing the Guidebook. If you are already familiar to the wiki software, please read the Purpose and the Conventions.

Note that you cannot edit unless you have an account. To get an account, contact the webmaster with your preferred username.

Purpose

The Guidebook is a repository of information that is editable by the Shehaqua Family community. With diverse programs for all ages, the Guidebook is a living document that disseminates knowledge to the entire community.

Editing

This is a quick introduction to the wiki software. Consult the User's Guide for a full manual on how to use the wiki software.

Creating and Editing Pages

To create a new page, first create a link to the page on an existing page. That link will display in red. Click on the link. You will be shown a screen with an editor.

To edit a page, click the "Edit" tab at the top of the page. The "Edit" tab is between the "Read" and "View History" tabs.

Once you are done making changes, type a quick summary in the summary box at the bottom and then press the "Save Page" button at the bottom of the page.

Editing the Text

Editing the Guidebook text is done using wikitext. As of December 2013, there does not exist a "nice" editor (a.k.a. WYSIWYG editor) for the wiki that is stable. However, the wikitext syntax is very easy to use, and there exists a toolbar with quick links so the user can edit without memorizing the codes.

Helpful buttons on the editor.

When you click on the bold, italic, or any of the buttons underneath the "Advanced" menu, some text will automatically be inserted into the editing area where your cursor is. The "Help" menu give some quick examples that make it easy to understand how this works. Here is an example of a bulleted list (also available under the "Advanced" menu.

* List Item
* List Item
** Indented List Item
*** Very Indented List Item
* Last List Item

produces

  • List Item
  • List Item
    • Indented List Item
      • Very Indented List Item
  • Last List Item

Other Important Codes

[[Category:Category Name]] is the way to label a page as being part of a category. The page will then be automatically added to the category listing. All of the staff assignments, for example, have [[Category:Staff Descriptions]] on the bottom of the page, and as a result, all the staff assignments are automatically added to Category:Staff Descriptions.

Uploading Files

To upload a file, go to Special:Upload or use the "Upload file" link that is in the left navigation menu underneath "Toolbox." Remember the destination filename that you give the file! If you forget the name that you gave the file, you can try to find it again in Special:ListFiles. Then go to the article where the image is to be inserted and use the "Insert Image" button.

Conventions

The purpose of the conventions in the Guidebook is to keep the information organized. Where the convention is intentionally vague, the exact method is left to the editor's discretion for what works best. If something is unclear, find some work done by the Operations Circle that is similar to what you are doing and copy the layout.

One convention that is applied everywhere is that every longer page should start with a one-sentence abstract as the first sentence in a paragraph-long introduction.

Organization of the Guidebook

There are three sections in the Guidebook

The Assignments section contains information on how participants are to do the assignments (a.k.a. jobs) during the program.

The Programs section contains helpful informaton for the staff of each program.

The Shehaqua Circles section contains public information on each circle.

Assignments

Each page in the assignments section should only have one assignment on it and should be part of the Staff Descriptions category.

Programs

Examples of what might go on the Guidebook and not the website:
  • Typical budgets
  • Accepted interpretations of our policy
  • Local hotel information

Do not duplicate information that is available on the website. Information that belongs on the website include:

  • Directions
  • A tour or other description of the program aimed at newcomers
  • Fees and policy information

Certain information does not belong on either the Guidebook or the website include.

  • Discussions of any kind
  • Meeting agendas. Many Circles use Google Drive for this purpose.
  • Any document with personal details

Shehaqua Circles

Each circle has a page in the Shehaqua Circles section to