Dev: Development standards: Difference between revisions

From Memento Database Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 6: Line 6:
|- style="text-align:left;"
|- style="text-align:left;"
| style="width:20%; text-align:center;" | '''Page names'''
| style="width:20%; text-align:center;" | '''Page names'''
| style="width 10%; text-align:center;" | 2020 Aug 21
| 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.
| 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.
The remainder of the name should be the natural name of the page.
|-
|-
| style="text-align:center;" | '''Category names'''
| style="text-align:center;" | '''Category names'''
| style="text-align:center;" | 2020 Aug 21
| 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.
|}
 
{| class="wikitable"
|+ Pages
! 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.
|}
 
{| class="wikitable"
|+ Headings
! 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.
|}
 
{| 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.
|}
 
{| class="wikitable"
|+ Templates
! 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.
|}
 
{| class="wikitable"
|+ Work migration
! 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.
|}
 
{| class="wikitable"
|+ Authoring
! 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.
|}
 
{| class="wikitable"
|+ Review
! 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.
|}
 
{| class="wikitable"
|+ Staging
! 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.
|}
 
{| class="wikitable"
|+ Releasing from Staging to the wiki
! 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.
|}
 
{| class="wikitable"
|+ Administration
! 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.
| Proposed category names will be reviewed by the team for approval.
They should be a single word or words containing no spaces.
They should be a single word or words containing no spaces.

Revision as of 09:43, 21 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
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
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 guidelines

Naming
For As of date Guideline
Page names 2020 Aug 21 Page names should be as indicative as possible of the function being described.
Category names 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
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.

Wiki development glossary

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