Difference between revisions of "Format Guidelines for PSUGCAL"
(→Page Names and Titles) |
(→Basic Text Formatting) |
||
Line 12: | Line 12: | ||
<pre>[[Category:Contents]]</pre> | <pre>[[Category:Contents]]</pre> | ||
− | == Basic | + | == Basic Formatting == |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 24: | Line 24: | ||
|- | |- | ||
| <nowiki><nowiki>no ''markup''</nowiki></nowiki>||<nowiki>no ''markup''</nowiki> | | <nowiki><nowiki>no ''markup''</nowiki></nowiki>||<nowiki>no ''markup''</nowiki> | ||
+ | |- | ||
+ | | | ||
+ | <nowiki>Single line breaks | ||
+ | are ignored</nowiki> | ||
+ | | | ||
+ | Single line breaks | ||
+ | are ignored | ||
|} | |} | ||
Revision as of 20:33, 11 April 2018
These are guidelines to making PSUGCal.org pages look consistent and to help with Wiki formatting in general. For more complete WikiMedia formatting help, visit https://www.mediawiki.org/wiki/Help:Formatting
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 in an alphabetical sort. Bad=Examples of sqlReports. Good=sqlReports.
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 Formatting
Code | Result |
---|---|
''italic'' | italic |
'''bold''' | bold |
'''''bold and italic''''' | bold and italic |
<nowiki>no ''markup''</nowiki> | no ''markup'' |
Single line breaks are ignored |
Single line breaks are ignored |
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 |
---|---|
== Heading Level 2 == Some text here === Heading Level 3 === Some more text here |
Heading Level 2Some text here Heading Level 3Some more text here |
A page with 4 or more headings will automatically create a table of contents
Bullets and Numbering
Code | Result |
---|---|
* For bullets start each line |
|
# Start each line |
|
Links
Description | Code | Result |
---|---|---|
Internal Link |
[[Main Page]] |
|
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] |
For consistency, most links will display best as a bullet item, with the link followed by a description. So for this:
- PSUGCal.org - Home of the California PowerSchool User Groups.
Type this:
* [http://www.psugcal.org PSUGCal.org] - Home of the California PowerSchool User Groups.
Posting Code
Use <pre>Insert Code here</pre> to post code. Example:
<script> $j(function() { /* place the family id row at the beginning of the table */ $j("table:first").prepend($j("#familyidrow")); ....
Tables
The "Advanced" toolbar in the editor can help with table formatting. But here is an example:
{| class="wikitable" |- ! Header text !! Header text !! Header text |- | Example || Example || Example |- | Example || Example || Example |}
Will produce this:
Header text | Header text | Header text |
---|---|---|
Example | Example | Example |
Example | Example | Example |
Files
More content coming soon.