Format Guidelines for PSUGCAL

From California PowerSchool User Group
Revision as of 20:07, 11 April 2018 by Rsprik (talk | contribs) (Links)
Jump to: navigation, search

These are guidelines to making PSUGCal.org pages look consistent and to help with Wiki formatting in general.

Contents

Page Names and Titles

Pages will automatically inherit the page name as their title. If you're creating a new page, choose a name with that in mind. The pages will automatically alphabetize in the Content Directory, so choose names that users would logically expect to find them under. Examples:

  • Customization
  • Health
  • GPA

Adding pages to the Content Directory

To automatically have a page be listed in the Content Directory, add this code to any part of your page:

[[Category:Contents]]

Basic Text Formatting

Code Result
''italic'' italic
'''bold''' bold
'''''bold and italic''''' bold and italic
<nowiki>no ''markup''</nowiki> no ''markup''

Headings

Wiki pages look best when organized with headings, like the one above this line. Use at most Level 2 and Level 3 headers. (Consider the Title of the Page Level 1). Here is the wiki code for creating the headings:

Code Result
== Header Level 2 == 
=== Header Level 3 ===

Header Level 2

Header Level 3

A page with 4 or more headings will automatically create a table of contents

Bullets and Numbering

Code Result

* For bullets start each line
* with an asterisk (*).
** More asterisks give deeper
*** and deeper levels.

  • For bullets start each line
  • with an (*).
    • More asterisks give deeper
      • and deeper levels.

# Start each line
# with a number sign (#).
## More number signs give deeper
### and deeper
### levels.

  1. Start each line
  2. with a number sign (#).
    1. More number signs give deeper
      1. and deeper
      2. levels.

Links

Description Code Result
Internal Link

[[Main Page]]
[[Main Page|Alternate Link Text]]

Main Page
Alternate Link Text

Bare External Link http://www.psugcal.org http://www.psugcal.org
External Link with Link Text
Note the single bracket and the space between the link and the link text

[http://www.psugcal.org PSUGCal.org]

PSUGCal.org

Example Example Example