Dev: Development standards: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ Naming | |+ Naming | ||
! For !! Standard | ! For !! As of date !! Standard | ||
|- 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: | | style="width 10%; text-align:center;" | 2020 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. | 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 | |||
| 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. | ||
| Line 17: | Line 19: | ||
== Wiki development guidelines == | == Wiki development guidelines == | ||
{| class="wikitable" | |||
|+ Naming | |||
! For !! As of date !! Guideline | |||
|- style="text-align:left;" | |||
| style="width:20%; text-align:center;" | '''Page names''' | |||
| style="width:10%; text-align:center;" | 2020 Aug 21 | |||
| style="width:70%"; | Page names should be as indicative as possible of the function being described. | |||
|- | |||
| 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. | |||
|} | |||
== Wiki development conventions == | |||
{| class="wikitable" | |||
|+ Naming | |||
! 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. | |||
|} | |||
== Wiki development glossary == | == Wiki development glossary == | ||
Revision as of 09:12, 21 August 2020
Wiki development standards
| For | As of date | Standard |
|---|---|---|
| Page names | 2020 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 | 2020 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
| 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
| 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
| 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 |
| 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 |