Help:Editing

From Shopp Documentation

Jump to: navigation, search

Contents


The Shopp documentation project is a wiki, so anyone can edit it. So dive in and start editing!

It's very easy to edit the documentation project wiki.

  • Click the edit link in the sidebar under the "Views" heading.
  • Make changes to the text.
  • Click the save page button

Etiquette

  1. Be courteous - do not engage in personal attacks.
  2. Add user pages before releasing a new page into the main documentation.
  3. Add often!
  4. Edit. Edit. Edit.
  5. If you're not sure, just ask in the discussion pages.
  6. Don't bad mouth the competition. Competition is good!

Formatting Reference

Wiki's use a special formatting that gets translated into the proper mark-up.

Basic Formatting

Here's a quick reference for the basics:

Italic: ''your text'' → yourtext
Bold: '''your text''' → yourtext
Lists:

* Bulleted List
* Second Item
** Sub-list Item

→
  • Bulleted List
  • Second Item
    • Sub-list Item

# Numbered List
# Second Item
## Sub-list Item

→
  1. Numbered List
  2. Second Item
    1. Sub-list Item
Text Indents:

:Single indent
::Double indent
:::::Multiple indent

→
Single indent
Double indent
Multiple indent
Section Headings:

= Level 1 =
== Level 2 ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====

→ (Level 1 reserved for page titles)

Level 2
Level 3
Level 4
Level 5

Links

Here's how to create links:

Internal Link: [[Main Page]] → Main Page
Labelled Link: [[Main Page|Link label here]] → Link label here
External Link: http://shopplugin.net → http://shopplugin.net
Labelled External Link: [http://shopplugin.net Shopp Website] → Shopp Website
Redirect #REDIRECT [[Main Page]] → → Main Page

Article Status

Help indicate the status of an article using the following "stubs":

{{NeedsWritten}}
The NeedWritten tag marks the page as a placeholder that needs a first draft written. Use this on pages that you are linking to that don't exist, but should to suggest new topics in the documentation.

{{Stub}}
The Stub marks the page as incomplete and requires more editing or more information.

{{Draft}}
Added to the top of a page to notify people that the page is a work in progress, some of the information contained on the page may be inaccurate or incorrect. It also helps warn others not to edit it until you are finished with it.

{{Copyedit}}
Copyedit flags articles that need more work, perhaps a brief review and refinements. This is usually used on articles that are fairly complete, and just need editorial review. Use {{Stub}} for incomplete articles.

[[Category:New page]]
Marks the page as new and will attract editors to begin refining the content. Don't use this until you are ready for others to edit/move your article out into the main documentation from your user page.

Page Titles & Headings

All titles and headings should use proper Title Case. For example, use "Adding a New Product" not "Adding a new product". Use proper spacing and complete (not contracted) words in titles and headings. Not "IntroToShopp" but "Introduction to Shopp".

  1. Proper title case capitalizes the first word, last word and all words in between except: a, an, the, in, of, to, and, but
  2. Titles should be action/task oriented where possible. "Adding a New Product" is preferred to "New Products" for example. Think about what words readers will use when searching for information.
  3. Titles should not have leading or trailing spaces, or unnecessary spaces between words. Try to avoid using symbols such as "-", "+", "?", "#"
  4. Shorter is better
  5. Avoid using prepositions in titles and headings as much as possible
  6. Do not use CamelCase for page titles. Use normal spacing such as "About Shopp", linked with [[About Shopp]] not the CamelCase form, "AboutShopp".

Conventions

  1. Be conversational, where possible.
  2. Be technical only when necessary.
  3. Be instructional, not a novel writer - write for the reader, focusing on the instruction of how to do something, not how you figured it out, who helped you, or what guided your decisions.
  4. Shopp-owner: Shopp-owner is used to refer to the owner and administrator of the Shopp plugin.
  5. Shopper or customer should be used to refer to the public use of Shopp
  6. Shopp Author, Ingenesis or Jon is used when referring to the creator and developer of Shopp
  7. Developer refers to third-party developers capable of working with the programming aspects of WordPress themes and Shopp templates.

Related Topics

Retrieved from "http://docs.shopplugin.net/Help:Editing"