Difference between revisions of "Dev: Development standards"

From Memento Database Wiki
Jump to: navigation, search
(Created page with "= Wiki development standards = ;Internal references: The symbol º is used to refer to another term, phrase, or sentence within the current page. For example: ::'''BUG...")
 
m
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Wiki development standards =
+
== Wiki development standards ==
  
;Internal references: The symbol º is used to refer to another term, phrase, or sentence within the current page. For example:
+
=== Naming ===
::'''[[BUG JUST BELOW]]'''
+
{| class="wikitable"
::; A funny term; See the term Xyzzyº
+
! For !! As of date !! Standard
:::...
+
|- style="text-align:left;"
::; Xyzzy: A "magic" word from the video game ADVENT that had been popular long ago. It became popular as a nonsense word and is now found all around the Internet especially among the gaming and software development communities, but among other communities as well.
+
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Pages ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|-
 +
| style="width:15%; text-align:center;" | '''Pages'''
 +
''Distinct<br/>
 +
& identifiable''
 +
| style="width 10%; text-align:center;" | Aug 22
 +
| style="width:75%;" | Pages should encapsulate information about an identifiable subject that is distinct from others that address the subject.
 +
|- style="text-align:left;"
 +
| style="text-align:center;" | '''Pages'''
 +
''Versions<br/>& timestamps''
 +
| style="text-align:center;" | Aug 22
 +
| Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.
 +
The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.
 +
|}
 +
 
 +
=== Headings ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Tables ===
 +
{| class="wikitable"
 +
|+ Tables
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Templates ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Work migration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Authoring ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Review ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Staging ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
'''[[UNFINISHED PAGE: Identifiers, types, & Versions]]'''
 +
 
 +
=== '''Staged work''' -- ''Deploying to the wiki'' ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''TBD'''symbol
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Administration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
== Wiki development guidelines ==
 +
 
 +
=== Naming ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Pages ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Version & timestamp'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.
 +
The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.
 +
|}
 +
 
 +
=== Headings ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Tables ===
 +
{| class="wikitable"
 +
|+ Tables
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Templates ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Work migration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Authoring ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Review ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Staging ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Releasing from Staging to the wiki ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Administration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
 
 +
== Wiki development conventions ==
 +
 
 +
=== Naming conventions
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width:10%"; | 2020 Aug 21
 +
| style="width:70%;" | Page names are not constrained in any way beyond the standards & guidelines.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
=== Naming ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Pages ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Version & timestamp'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.
 +
The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.
 +
|}
 +
 
 +
=== Headings ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Tables ===
 +
{| class="wikitable"
 +
|+ Tables
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Templates ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Work migration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Authoring ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Review ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Staging ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Releasing from Staging to the wiki ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
=== Administration ===
 +
{| class="wikitable"
 +
! For !! As of date !! Standard
 +
|- style="text-align:left;"
 +
| style="width:20%; text-align:center;" | '''Page names'''
 +
| style="width 10%; text-align:center;" | Aug 21
 +
| style="width:70%"; | Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.
 +
The remainder of the name should be the natural name of the page.
 +
|-
 +
| style="text-align:center;" | '''Category names'''
 +
| style="text-align:center;" | Aug 21
 +
| Proposed category names will be reviewed by the team for approval.
 +
They should be a single word or words containing no spaces.
 +
|}
 +
 
 +
== Wiki development glossary ==
 +
 
 +
=== Glossary of terms ===
 +
{| class="wikitable" style="text-align: top, left;"
 +
|+ Standard terminology in Memento wiki development
 +
! Term !! Definition !! Usage
 +
|-
 +
| style="width:20%; text-align:center;" | '''Development'''
 +
| style="width:60%;" | A generic term for the construction or assembly of items, often within a specific context
 +
|
 +
|-
 +
| style="text-align:center;" |'''Development environment'''
 +
| A set of procedures & tools that work together to help development teams accomplish their joint mission of managing phases'''^''' including development, testing and/or review, acceptance by users (if appropriate), and deployment into a production environment along with the process of migrating^ the software or other items being developed from phase to phase. (Not a sentence.) ||
 +
|-
 +
| style="text-align:center;" | '''Development phase'''
 +
| A phase of the development process
 +
|
 +
|-
 +
| style="text-align:center;" | '''Internal references'''
 +
| The symbol '''^''' is used to refer to another term, phrase, or sentence within the current page.
 +
| For example: API'''^'''
 +
|-
 +
| style="text-align:center;" | '''Work migration''' || The movement of software, Web pages, or other items being developed from one phase to the next
 +
|
 +
|}
 +
 
 +
=== Abbreviations & acronyms ===
 +
{| class="wikitable"
 +
! Abbreviation/Acronym !! Short for term !! Definition
 +
|-
 +
| style="width:15%; text-align:center;" | '''API'''
 +
| style="width:25%; text-align:center;" | Application Programming Interface
 +
| style="width:60%;"|
 +
|-
 +
| style="text-align:center;" | '''DevEnv'''
 +
| style="text-align:center;" | Development Environment
 +
| The set of development wiki pages that support development of the wiki, used by authors & administrators
 +
|-
 +
| style="text-align:center;" | '''DOM'''
 +
| style="text-align:center;" | Document Object Model
 +
|
 +
|-
 +
| style="text-align:center;" | '''JS'''
 +
| style="text-align:center;" | JavaScript
 +
| An object-based scripting language developed originally for the purpose of programming actions within a Web browser rather than within a Web server.
 +
It consists of general scripting functions and a special set of functions referred to as the DOM'''^''', or Document Object Model'''^'''.
 +
|-
 +
| style="text-align:center;" | '''MJ'''
 +
| style="text-align:center;" | Memento JavaScript
 +
| The subset of the JavaScript scripting language that is supported by Memento to specify the things to be done by Memento upon certain specific events
 +
|-
 +
| style="text-align:center;" | '''MJL'''
 +
| style="text-align:center;" | The Memento JavaScript Library
 +
| The JavaScript'''^''' library that provides an API'''^''' to the Rhino JavaScript engine within Memento that implements a subset of JavaScript that omits the DOM.
 +
|-
 +
| style="text-align:center;" | '''MW'''
 +
| style="text-align:center;" | The Memento Wiki
 +
|
 +
|}
  
 
[[Category: Dev]]
 
[[Category: Dev]]

Latest revision as of 10:43, 23 August 2020

Wiki development standards

Naming

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Pages

For As of date Standard
Pages

Distinct
& identifiable

Aug 22 Pages should encapsulate information about an identifiable subject that is distinct from others that address the subject.
Pages

Versions
& timestamps

Aug 22 Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.

The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.

Headings

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Tables

Tables
For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Templates

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Work migration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Authoring

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Review

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Staging

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

UNFINISHED PAGE: Identifiers, types, & Versions

Staged work -- Deploying to the wiki

For As of date Standard
TBDsymbol Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Administration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Wiki development guidelines

Naming

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Pages

For As of date Standard
Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Version & timestamp Aug 21 Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.

The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.

Headings

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Tables

Tables
For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Templates

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Work migration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Authoring

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Review

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Staging

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Releasing from Staging to the wiki

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Administration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.


Wiki development conventions

=== Naming conventions

For As of date Standard
Page names 2020 Aug 21 Page names are not constrained in any way beyond the standards & guidelines.
Category names Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Naming

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Pages

For As of date Standard
Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Version & timestamp Aug 21 Every wiki page of any stripe should have in the upper-right corner the date, time, mobile version, and desktop version.

The Stamp template should be used for this. It has these four values as arguments. This is manually updated, so caution should be used to keep it updated every time it changes.

Headings

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Tables

Tables
For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Templates

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Work migration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Authoring

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Review

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Staging

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Releasing from Staging to the wiki

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Administration

For As of date Standard
Page names Aug 21 Page names should begin with the category of the page followed by a colon followed by a space, unless that category is Main, in which case, it is omitted.

The remainder of the name should be the natural name of the page.

Category names Aug 21 Proposed category names will be reviewed by the team for approval.

They should be a single word or words containing no spaces.

Wiki development glossary

Glossary of terms

Standard terminology in Memento wiki development
Term Definition Usage
Development A generic term for the construction or assembly of items, often within a specific context
Development environment A set of procedures & tools that work together to help development teams accomplish their joint mission of managing phases^ including development, testing and/or review, acceptance by users (if appropriate), and deployment into a production environment along with the process of migrating^ the software or other items being developed from phase to phase. (Not a sentence.)
Development phase A phase of the development process
Internal references The symbol ^ is used to refer to another term, phrase, or sentence within the current page. For example: API^
Work migration The movement of software, Web pages, or other items being developed from one phase to the next

Abbreviations & acronyms

Abbreviation/Acronym Short for term Definition
API Application Programming Interface
DevEnv Development Environment The set of development wiki pages that support development of the wiki, used by authors & administrators
DOM Document Object Model
JS JavaScript An object-based scripting language developed originally for the purpose of programming actions within a Web browser rather than within a Web server.

It consists of general scripting functions and a special set of functions referred to as the DOM^, or Document Object Model^.

MJ Memento JavaScript The subset of the JavaScript scripting language that is supported by Memento to specify the things to be done by Memento upon certain specific events
MJL The Memento JavaScript Library The JavaScript^ library that provides an API^ to the Rhino JavaScript engine within Memento that implements a subset of JavaScript that omits the DOM.
MW The Memento Wiki