Wiki Editing Guide: Difference between revisions

From Digital Grail Convention Wiki
Jump to navigation Jump to search
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Official Documentation==
==Official Documentation==
[https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting]
[https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting]
==Questions or Uncertainties==
If any of the below information has you confused and you want clarification please email webmaster@digitalgrail.org.
If you have questions or doubts when editing feel free to use the form link on the [[Main Page]].
==Naming Conventions==
* For pages that would share a common name but are meant to be convention specific add a " - <convention name>" to them.
** For example: [[Volunteers Timeline]] & [[Volunteers Timeline - Fargo CoreCon]]
*** for these pages like these you'll add the department category & the convention category (see that section of this page).
* If a category is marked only for one convention but the convention you're a part of uses it, then you'll need to do the following:
*# Remove the convention specific category on the Category page.
*# Go to each sub page of the category and determine if the information applies to your convention or not.
*## if not then rename that page (top right menu: More > Move) following the above guidelines.
*## For an example of this check out [[Volunteers Timeline]] & [[Volunteers Timeline - Fargo CoreCon]] (The public relevant info is in the first, and ONLY the convention specific info is in the convention specific page).
*## For the convention specific page add the category for the convention.
*# Add any additional pages that are your convention specific as well, following the guidelines listed here.
==Updating a page==
* If a page already exists and you need to add info to it, please just do so.
===If you find a page has information irrelevant to your convention===
# Email the other 2 convention's department for that category
#* For example if you find something on [[Volunteers]], [[Volunteers Timeline]], etc is wrong then email volunteers@<convention name with no spaces>.org for all other conventions and inquire about the information.
#*** IE if you're in Fargo Gamefest then you'd email volunteers@fargocorecon.org and volunteers@animefargo.org.
## If it's determined that neither other convention uses this, then delete the offending information.
## If only 1 of the other conventions  use it, then find or create the convention specific page for that object (see Naming Conventions above) and add the information correctly to the new page then delete it on the general page.
## If both of the other conventions use that information then leave it in, and if you feel it's needed you can find or create your convention's specific page and identify that the offending information is not used for your convention or you can identify if it's worth incorporating the information into your convention.


==Common formatting==
==Common formatting==
Line 10: Line 38:
===Header format===
===Header format===
* To make a header like the one above here then you should surround the text with 2 ='s signs.
* To make a header like the one above here then you should surround the text with 2 ='s signs.
** Example: "==This is a header=="
** Example: <code>==This is a header==</code>


===Sub Header Format===
===Sub Header Format===
* Sub headers just add extra ='s on each side.  
* Sub headers just add extra ='s on each side.  
** Example: For a sub header to "Common Formatting" you'd just need to add a line below that and put "===Sub Header===".
** Example: For a sub header to "Common Formatting" you'd just need to add a line below that and put <code>===Sub Header===</code>
** this maxes out at "======" on each side.
** this maxes out at <code>======</code> on each side.


===List format===
===List format===
* To make items in a bulleted list like this one you use "* " before the text. To indent bullets you can just add more *'s
* To make items in a bulleted list like this one you use "* " before the text. To indent bullets you can just add more *'s
** Example: "* This is will be bulleted like the line above" or "** This will be bulleted like this line is"
** Example: <code>* This is will be bulleted like the line above</code> or <code>** This will be bulleted like this line is</code>
* To make a numbered list you use "# ". And like the above you simply add more #'s to add intended lines.
* To make a numbered list you use "# ". And like the above you simply add more #'s to add intended lines.


===Italics===
===Italics===
* To ''italicize'' text you surround it with two 's on each side.
* To ''italicize'' text you surround it with two 's on each side.
** Example (remove space between the ') ' 'Italics' '
** Example: <code><nowiki>''Italics''</nowiki></code>


===Bold===
===Bold===
* Bold works like Italics except it's 3 ' instead of 2.
* Bold works like Italics except it's 3 ' instead of 2.
** Example (remove space between the ') ' ' 'Bold' ' '
** Example: <code><nowiki>'''Bold'''</nowiki></code>


===Bold & Italics===
===Bold & Italics===
* This is simply 5 ' on each side. 2 for italic and 3 for bold.
* This is simply 5 ' on each side. 2 for italic and 3 for bold.
**Example (remove space between the ') ' ' ' ' 'bold & italic' ' ' ' '
**Example: <code><nowiki>'''''bold & italic'''''</nowiki></code>


===Page Linking===
===Page Linking===
* To link a page you simply do [ [your page title] ] (Remove the space between [ [ and ] ])
* To link a page you simply do <code><nowiki>[[your page title]]</nowiki></code>


===Link to a Category Page===
===Link to a Category Page===
* To link to a category simply do [ [:Category:''category name''| ''Text to be displayed'' ] ] (Remove the space between [ [ and ] ])
* To link to a category simply do <code><nowiki>[[:Category:''category name''| ''Text to be displayed'' ]]</nowiki></code>
** The end result is what you see on the main page under "Staff Information"
** The end result is what you see on the main page under "Staff Information"


===Linking between the public and private wiki===
===Linking between the public and private wiki===
* If on the public wiki (like we are now) you can do the following to link to a page on the private wiki [[privatewiki:<Your Page>]]
* If on the public wiki (like we are now) you can do the following to link to a page on the private wiki [[privatewiki:<Your Page>]]
** Example: (remove the spaces between [ [ and ] ]) [ [privatewiki:Main Page] ]
** Example: <code><nowiki>[[privatewiki:Main Page]]</nowiki></code>
*** The above will show "privatewiki:Main Page" when reading.
*** The above will show "privatewiki:Main Page" when reading.
** You can also add after <your page> a | and then a better wording for the link. Example [ [privatewiki:<your page>|Link to your page] ].
** You can also add after <your page> a | and then a better wording for the link. Example <code><nowiki>[[privatewiki:<your page>|Link to your page]]</nowiki></code>.
*** the above will show the text "Link to your page" when reading.
*** the above will show the text "Link to your page" when reading.
* For linking to categories instead of <your page> you'd do "Category:<your category>".
* For linking to categories instead of <your page> you'd do "Category:<your category>".
** Example: (remove the spaces between [ [ and ] ]) [ [privatewiki:Category:Departments] ]
** Example: <code><nowiki>[[privatewiki:Category:Departments]]</nowiki></code>
*** The above will show "privatewiki:Category:Departments" on the reading page.
*** The above will show "privatewiki:Category:Departments" on the reading page.
** Example using the better wording: [ [privatewiki:Category:Departments|Departments on the private wiki] ]
** Example using the better wording: <code><nowiki>[[privatewiki:Category:Departments|Departments on the private wiki]]</nowiki></code>
*** The above will show "Departments on the private wiki"
*** The above will show "Departments on the private wiki"
* If on the private wiki and linking to the public then you'd use "publicwiki" instead of "privatewiki" in the above examples
* If on the private wiki and linking to the public then you'd use "publicwiki" instead of "privatewiki" in the above examples
Line 64: Line 92:


===Category Requirements===
===Category Requirements===
* For department category pages you must use [ [Category:Departments] ] (Remove the space between [ [ and ] ]) as that's for the complete department list, regardless of convention specific or general.
* For department category pages you must use <code><nowiki>[[Category:Departments]]</nowiki></code> as that's for the complete department list, regardless of convention specific or general.
** See [[:Category:Accessibility|Accessibility Category]] for an example.
** See [[:Category:Accessibility|Accessibility Category]] for an example.
==Templates==
* We have some templates available. They are titled "Template:<name>". 2 such templates that are useful are the AFEmail and CCEmail templates.
** To use these templates you do the following: <code><nowiki>{{AFEmail|accessibility}}</nowiki></code> which produces <code>{{AFEmail|accessibility}}</code>
** For CCEmail you simply use CCEmail instead of AFEmail.
** Check out [[Template:AFEmail]] if you want to see how templates work.

Latest revision as of 10:39, 23 November 2022

Official Documentation

MediaWiki Formatting

Questions or Uncertainties

If any of the below information has you confused and you want clarification please email webmaster@digitalgrail.org.

If you have questions or doubts when editing feel free to use the form link on the Main Page.

Naming Conventions

  • For pages that would share a common name but are meant to be convention specific add a " - <convention name>" to them.
  • If a category is marked only for one convention but the convention you're a part of uses it, then you'll need to do the following:
    1. Remove the convention specific category on the Category page.
    2. Go to each sub page of the category and determine if the information applies to your convention or not.
      1. if not then rename that page (top right menu: More > Move) following the above guidelines.
      2. For an example of this check out Volunteers Timeline & Volunteers Timeline - Fargo CoreCon (The public relevant info is in the first, and ONLY the convention specific info is in the convention specific page).
      3. For the convention specific page add the category for the convention.
    3. Add any additional pages that are your convention specific as well, following the guidelines listed here.

Updating a page

  • If a page already exists and you need to add info to it, please just do so.

If you find a page has information irrelevant to your convention

  1. Email the other 2 convention's department for that category
    • For example if you find something on Volunteers, Volunteers Timeline, etc is wrong then email volunteers@<convention name with no spaces>.org for all other conventions and inquire about the information.
        • IE if you're in Fargo Gamefest then you'd email volunteers@fargocorecon.org and volunteers@animefargo.org.
    1. If it's determined that neither other convention uses this, then delete the offending information.
    2. If only 1 of the other conventions use it, then find or create the convention specific page for that object (see Naming Conventions above) and add the information correctly to the new page then delete it on the general page.
    3. If both of the other conventions use that information then leave it in, and if you feel it's needed you can find or create your convention's specific page and identify that the offending information is not used for your convention or you can identify if it's worth incorporating the information into your convention.

Common formatting

Side note - The Table Of Contents at the top gets created automatically by using headers.

  • Also remember that most of the documents here (unless specifically placed in a convention specific category) are for each convention.
  • Instead of "Fargo CoreCon" or "Anime Fargo", use "the convention"
  • Instead of "accessibility@fargocorecon.org" use "Accessbility".

Header format

  • To make a header like the one above here then you should surround the text with 2 ='s signs.
    • Example: ==This is a header==

Sub Header Format

  • Sub headers just add extra ='s on each side.
    • Example: For a sub header to "Common Formatting" you'd just need to add a line below that and put ===Sub Header===
    • this maxes out at ====== on each side.

List format

  • To make items in a bulleted list like this one you use "* " before the text. To indent bullets you can just add more *'s
    • Example: * This is will be bulleted like the line above or ** This will be bulleted like this line is
  • To make a numbered list you use "# ". And like the above you simply add more #'s to add intended lines.

Italics

  • To italicize text you surround it with two 's on each side.
    • Example: ''Italics''

Bold

  • Bold works like Italics except it's 3 ' instead of 2.
    • Example: '''Bold'''

Bold & Italics

  • This is simply 5 ' on each side. 2 for italic and 3 for bold.
    • Example: '''''bold & italic'''''

Page Linking

  • To link a page you simply do [[your page title]]

Link to a Category Page

  • To link to a category simply do [[:Category:''category name''| ''Text to be displayed'' ]]
    • The end result is what you see on the main page under "Staff Information"

Linking between the public and private wiki

  • If on the public wiki (like we are now) you can do the following to link to a page on the private wiki [[privatewiki:<Your Page>]]
    • Example: [[privatewiki:Main Page]]
      • The above will show "privatewiki:Main Page" when reading.
    • You can also add after <your page> a | and then a better wording for the link. Example [[privatewiki:<your page>|Link to your page]].
      • the above will show the text "Link to your page" when reading.
  • For linking to categories instead of <your page> you'd do "Category:<your category>".
    • Example: [[privatewiki:Category:Departments]]
      • The above will show "privatewiki:Category:Departments" on the reading page.
    • Example using the better wording: [[privatewiki:Category:Departments|Departments on the private wiki]]
      • The above will show "Departments on the private wiki"
  • If on the private wiki and linking to the public then you'd use "publicwiki" instead of "privatewiki" in the above examples

Categories

  • Categories only need to be worried about for new pages.
  • The biggest thing for categories is that we want to each page to link to it's department category, and if applicable (IE the department category is a general one, but this page is specific to a convention) the convention the page is specific for.
  • Then you ensure the Department Category is linked to either General if it's a category that exists in both conventions or to the Convention that the category is for.

How to declare a category

  • To declare a category then you need to use (on it's own separate line - best practice is at the top but can be wherever) [[Category:<your category>]].
    • Categories can have spaces.

Category Requirements

  • For department category pages you must use [[Category:Departments]] as that's for the complete department list, regardless of convention specific or general.

Templates

  • We have some templates available. They are titled "Template:<name>". 2 such templates that are useful are the AFEmail and CCEmail templates.
    • To use these templates you do the following: {{AFEmail|accessibility}} which produces accessibility@animefargo.org
    • For CCEmail you simply use CCEmail instead of AFEmail.
    • Check out Template:AFEmail if you want to see how templates work.