Changes

Jump to: navigation, search

Format Guidelines for PSUGCAL

2,546 bytes added, 10:20, 17 April 2018
no edit summary
These are guidelines to making PSUGCal.org pages look consistent and to help with Wiki formatting in general. For more complete MediaWiki formatting help, visit https://www.mediawiki.org/wiki/Help:Formatting
 
== Creating a new page ==
A page (also known in MediaWiki as an "article") is very easy to create.
 
=== Using Wikilinks ===
MediaWiki makes it very easy to link wiki pages using a standard syntax (see Links section below). Example: <nowiki>[[Hobbies]]</nowiki>
 
If you (or anyone else) create a link to an article that doesn't exist yet, the link will be colored red, <span style="color: #ba0000">like this</span>.
 
Clicking a red link will take you to the edit page for the new article.
 
Simply type your text, click save and the new page will be created.
 
Once the page has been created, the link will change from <span style="color: #ba0000">red</span> to <span style="color: #002bb8;">blue</span> (<span style="color: #5a3696;">purple</span> for pages you've visited) indicating that the article now exists.
 
Usually this is the best way to create a new page, because it means that right from the start, the page will be linked from at least one other place on the wiki.
 
For many wikis, normally there is no reason to create a page without first creating a red link to it. However, for PSUGCal, if you add <nowiki>[[Category:Contents]]</nowiki> anywhere on your new page, it WILL be automatically listed in the "Content Directory" we feature as the 2nd link in the left navigation menu.
 
=== From the search box ===
 
If you search for a page that doesn't exist (using the search box at the top) then you will be provided with a link to create the new page.
 
=== Using the URL ===
 
You can use the wiki's URL for creating a new page.
 
The URL to an article of the PSUGCal.org wiki is usually something like this:
*<code><nowiki>https://www.psugcal.org/index.php?title=</nowiki>'''GPA'''</code>
 
If you replace <code>'''GPA'''</code> with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet.
 
Clicking the "edit" tab at the top of the page will take you to the edit page for that article, where you can create the new page by typing your text, and clicking submit.
 
== Page Names and Titles ==
Pages will automatically inherit the page name as their title and main heading at the top of the page. 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.<br />
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:
<pre>[[Category:Contents]]</pre>
 
== Sidebar/Left Navigation Editing ==
You can edit the left navigation or "Sidebar" with a special link:
* [[MediaWiki:Sidebar]]
or
* https://www.psugcal.org/index.php?title=MediaWiki:Sidebar
 
Find the "Quick Links" section and add an additional link with a special format consisting of:
* two asterisks + the page title + the pipe (|) symbol + the link text. You MUST have both the title and link text combo, even if they are identical, for the sidebar link to work correctly.
*Example: <code><nowiki>** Customization|Customization</nowiki></code>
== Basic Formatting ==
== Tables ==
The "Advanced" toolbar in the editor can help with table formatting. But here Here is an example:
<pre>
{| class="wikitable"
|}
== Files and Images ==More content coming soon* Files and images must first be uploaded before they can be inserted in your page/article, but fortunately, the toolbar in your page editor can help.# Click on the "Embedded File" button in your toolbar [[File:UploadFileButton.png|thumb|none]]# Click "Upload"# Select or "Drag and Drop" your file# Check the box to acknowledge that this is your work.# Click "Upload" [[File:UploadInterface.png|thumb|none]]# Add a description for the file or image# Click "Save"# Back in the "Insert File" dialog you should now add a caption# Choose an alignment and format. ("None" and "Thumb" are good for inline images, otherwise the default will align to the right)# Click "Insert" [[File:InsertFileInterface.png|thumb|none]] You will end up with a line of code that looks something like this (Bullet added, which is always a good idea for listing a file)<pre>* [[File:PowerQuery Example 1 0.zip|thumb|PowerQuery Example (Birthdays)]]</pre>and it will display like this:* [[File:PowerQuery Example 1 0.zip|thumb|PowerQuery Example (Birthdays)]] ''See the source code for this section to see how the screenshots are coded for inline display'' === Removing thumbnail to make a "download" only link ===By default, MediaWiki will always try to display an image for your file. If this is anything other than an image that you want displayed on the screen, it is a GOOD IDEA to change the "File" tag to "Media", which makes it strictly a download link without trying to display it. It also then uses your caption as the link text instead of the file name. So in the example above, if we change "File" to "Media" and remove any alignment and formatting options to leave just the filename and the caption, we get this (description also added for best practice):<pre>* [[Media:PowerQuery Example 1 0.zip|PowerQuery Example (Birthdays)]] - Very simple example of a PowerQuery for learning purposes.</pre>and it will display like this:* [[Media:PowerQuery Example 1 0.zip|PowerQuery Example (Birthdays)]] - Very simple example of a PowerQuery for learning purposes. If you'd like the filename listed as the link text, simply repeat the filename as the caption:<pre>* [[Media:PowerQuery Example 1 0.zip|PowerQuery Example 1 0.zip]] - Very simple example of a PowerQuery for learning purposes.</pre>* [[Media:PowerQuery Example 1 0.zip|PowerQuery Example 1 0.zip]] - Very simple example of a PowerQuery for learning purposes. == Creating a new page ==A page (also known in MediaWiki as an "article") is very easy to create. === Using Wikilinks ===MediaWiki makes it very easy to link wiki pages using a standard syntax (see Links section below). Example: <nowiki>[[Hobbies]]</nowiki> If you (or anyone else) create a link to an article that doesn't exist yet, the link will be colored red, <span style="color: #ba0000">like this</span>. Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from <span style="color: #ba0000">red</span> to <span style="color: #002bb8;">blue</span> (<span style="color: #5a3696;">purple</span> for pages you've visited) indicating that the article now exists. Usually this is the best way to create a new page, because it means that right from the start, the page will be linked from at least one other place on the wiki. For many wikis, normally there is no reason to create a page without first creating a red link to it. However, for PSUGCal, if you add <nowiki>[[Category:Contents]]</nowiki> anywhere on your new page, it WILL be automatically listed in the "Content Directory" we feature as the 2nd link in the left navigation menu. === From the search box === If you search for a page that doesn't exist (using the search box at the top) then you will be provided with a link to create the new page. === Using the URL === You can use the wiki's URL for creating a new page. The URL to an article of the PSUGCal.org wiki is usually something like this:*<code><nowiki>https://www.psugcal.org/index.php?title=</nowiki>'''GPA'''</code> If you replace <code>'''GPA'''</code> with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the "edit" tab at the top of the page will take you to the edit page for that article, where you can create the new page by typing your text, and clicking submit. == Page Names and Titles ==Pages will automatically inherit the page name as their title and main heading at the top of the page. 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.<br />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:<pre>[[Category:Contents]]</pre> == Sidebar/Left Navigation Editing ==You can edit the left navigation or "Sidebar" with a special link:* [[MediaWiki:Sidebar]]or* https://www.psugcal.org/index.php?title=MediaWiki:Sidebar Find the "Quick Links" section and add an additional link with a special format consisting of:* two asterisks + the page title + the pipe (|) symbol + the link text. You MUST have both the title and link text combo, even if they are identical, for the sidebar link to work correctly.*Example: <code><nowiki>** Customization|Customization</nowiki></code> == Meeting Page Template ==*[[Meeting Template]] - Find naming convention for the page and the code template to create a new meeting page.
[[Category:Contents]]

Navigation menu