WAG - Basic Page Formatting Guide: Difference between revisions
No edit summary |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category: Regulations]] | [[Category: Regulations]] | ||
{{DocRelInfo | {{DocRelInfo | ||
|articlenumber = 7CAV-DR-063 | |articlenumber = 7CAV-DR-063 | ||
|scope = Editing Best Practices | |scope = Editing Best Practices | ||
|version = | |version = 1.0 | ||
|effectivedate = | |effectivedate = 27JUN2025 | ||
|lastmodifieddate = | |lastmodifieddate = 27JUN2025 | ||
|approvingauthority = WAG 1IC | |approvingauthority = WAG 1IC | ||
|pointofcontact = WAG 1IC | |pointofcontact = WAG 1IC | ||
| Line 18: | Line 15: | ||
===Creating a New Page=== | ===Creating a New Page=== | ||
When new departments or units are stood up, we are often tasked with creating new pages for them. To create a new page, | When new departments or units are stood up, we are often tasked with creating new pages for them. To create a new page, enter the desired title into the search bar of the wiki. The following message should appear: | ||
[[file:NewPageCreationIMG.png | 600px]] | [[file:NewPageCreationIMG.png | 600px]] | ||
Latest revision as of 00:24, 28 June 2025
| This is the Document Release Information | |
| Article Number: | 7CAV-DR-063 |
| Scope: | Editing Best Practices |
| Version: | 1.0 |
| Effective Date: | 27JUN2025 |
| Last Modified Date: | 27JUN2025 |
| Approving Authority: | WAG 1IC |
| Point of Contact: | WAG 1IC |
Page Creation & Editing
Creating a New Page
When new departments or units are stood up, we are often tasked with creating new pages for them. To create a new page, enter the desired title into the search bar of the wiki. The following message should appear:
You can then click on the red link and begin to edit your newly created page. PLEASE AVOID OVERWRITING EXISTING PAGES UNLESS AUTHORIZED BY WAG 1IC
Formatting
Tips on basic formatting can be accessed on the Help:Formatting section of the MediaWiki website. Below is a table of our most frequently used text formatting markups.
| Description | You Type | You Get |
|---|---|---|
| Italic Text | ''italic'' |
italic |
| Bold Text | '''bold''' |
bold |
| Bold and italic | '''''bold & italic''''' |
bold & italic |
| Section Headings of different levels | ==Level 2== ===Level 3=== ====Level 4==== =====Level 5===== ======Level 6====== |
Level 2Level 3Level 4Level 5Level 6 |
| Bullet list | * Start each line * with an asterisk (*). ** More asterisks give deeper *** and deeper levels. * Line breaks <br>don't break levels. *** But jumping levels creates empty space. Any other start ends the list. * combine bullet list ** with definition ::- definition ** creates empty space * combine bullet list ** with definition *:- definition ** without empty spaces *bullet list :- definition :* sublist that doesn't create empty :* spaces after definition |
Any other start ends the list.
|
| Numbered List | # Start each line # with a (#). ## More number signs give deeper ### and deeper ### levels. # Line breaks <br>don't break levels. ### But jumping levels creates empty space. # Blank lines # end the list and start another. Any other start also ends the list. <nowiki># use "nowiki" tags to display a literal (#) at the beginning of a line without interpreting it as a numbered list.</nowiki> |
Any other start also ends the list. # use "nowiki" tags to display a literal (#) at the beginning of a line without interpreting it as a numbered list. |
Tables
Tables in a wiki can be a good way to display information in an organized and easy to read format. However, building tables can often be the hardest and most time consuming aspect of creating or editing a page. Below are some helpful tools in creating, editing, and formatting a table.
| Code | Description |
|---|---|
| {| | Table Start, required |
| |+ | Table Caption, optional; use only between Table Start and Table Row |
| |- | Table Row, optional on first row- wiki engine will automatically assume the first row, but it's good practice to add one anyways |
| ! | Table Header cell, optional - titles to your cell or column. Consecutive table header cells can be added on the same line separated by double marks (!!) or start on new lines, each with its own single mark (!)
|
| | | Table Data cell, optional - the main body of information going into your table. Like the header cells, these can also be added on the same line using double marks (||) or start on new lines, each with its own single mark (|)
|
| |} | Table End, required |
Links
Links are commonplace in the wiki, so it's our job to ensure that all links are working as intended and direct the user to the correct information. Below is a list of different types of links and their use on the wiki.
| Name | Code | Output | Use |
|---|---|---|---|
| Internal Link | [[Main Page]] |
Main Page | Generic markup for linking internal wiki pages |
| Piped Link | [[Main Page|Cav Main]] |
Cav Main | A piped link is used to rename a link if the context doesn't call for the original name to be used (ex; DEVCOM instead of Development Command, WAG instead of Wiki Admin Group, etc...) |
| External Link with Specified Link Text | [https://7cav.us/ Cav Forums] |
Cav Forums | Creates an external link with a customized text, especially useful for adding in-line links like in the example here |
| Numbered External Link | [https://7cav.us/] |
[1] | This is what happens when you omit any additional text after a link. It's not particularly user friendly on mobile, as the link gets exponentially smaller. Try to avoid whenever possible. |
| Bare External Link | https://7cav.us/ |
https://7cav.us/ | Websites that begin with http or https will automatically link. |
Templates
When creating a new page, it is important to use the predefined templates provided by the WAG HQ staff in order to foster uniformity and consistency throughout the wiki. Below are the links to our most commonly used template formats, as well as their scope and usage for page creation.
*Note* All templates are called using this format {{template:name}}
| Name | Use |
|---|---|
| Template:Approval | Used when a page needs secondary approval by WAG HQ or approving authority on a ticket. *Do not link a page that needs secondary approval to other live pages* |
| Template:DocRelInfo | Used for creating new SOPs. Parameters are predefined and listed on the template page. |
| Template:Header | 7CAV Wiki header. Used for non-departmental pages that are featured on the main page. (About Us, Medals & Awards, Supported Games, etc.) |
| Template:Infobox department | Used when creating new department pages. Parameters are predefined and listed on the template page. |
| Template:Infobox unit | Used when creating new unit pages. Parameters are predefined and listed on the template page. |
| Template:Obsolete | Used for marking outdated SOPs. |
| Template:Obsolete(Non-SOP) | Used for marking outdated non-SOP related pages. *Please link to the new page underneath the template* |
| Template:WIP | Used for marking pages that are not finished or are planned for editing. *Do not link unfinished pages to live pages* |
Categories
When creating new pages, please remember to utilize category tags so that pages can be easily referenced by WAG staff for auditing and quality assurance purposes. Below are the major categories we use and their usage.
*Note* All categories are called using this format [[Category:Name]]
| Name | Use |
|---|---|
| Category:Unit Organization | Main category used for both combat units and staff departments. |
| Category:Combat Unit | Subcategory of Unit Organization. Used specifically for combat units. |
| Category:Staff Departments | Subcategory of Unit Organization. Used specifically for Secondary & Support Departments. |
| Category:Obsolete | Used when marking pages obsolete. |
| Category:Regulations | Used for SOPs and informational pages. |
| Category:Server Administration | Used for pages that are related to our server administration procedures and tools. |
Accessibility
The whole point of having a wiki is for information about the Regiment and it's subordinates to be accessible to everyone, regardless of viewing device. Thus, it is our job to ensure that all users (PC, Mobile, Tablet, etc.) are offered the same experience when using the wiki.
To that end, the biggest culprit of innaccessibility is page banners. When page banners are set to span the top of a page, they are sized relative to a PC monitor, causing the banner to overflow on mobile and the page to shrink to an illegible size. Below is the format we should be using to accommodate mobile and tablet devices.
[[File:FileName|center|frameless|upright 2.5]]
Even though page banners may be the main culprit, you still need to be mindful of dimensions whenever you add any pictures to a page. When you complete a page and save it, load the page up on your phone to verify that you made the page as accessible as possible for mobile devices. If not, find the cause and try different format settings until the issue is corrected.
While we strive for accessibility, we recognize that we may not always hit the mark. We encourage all of our admins to be as collaborative as possible, meaning if you see something, say something. What may look good in mobile and regular monitor format may not be the same in widescreen or tablet.
Additional Tools & Markups
These additional tools are meant to elevate the work you put into creating or editing a page. These are by no means required, but it is good practice to familiarize yourself with these tools so that you gain an understanding of their function and purpose whenever you may come across them during your time here in the WAG. Additional material on how to use these tools can be found here.
| Name | Code | Use |
|---|---|---|
| Line Break | </br> |
Used to break up lines without beginning another paragraph
|
| Fixed Width Text | <code>Text</code> |
Used as an additional visual tool to enhance your page
|
| Blockquotes | <blockquote>Blockquote</blockquote> |
Used to
quotation marks |
