Dev: Memento wiki authoring templates

From Memento Database Wiki
Jump to navigation Jump to search
« Page as of 2021-02-22, editions Mobile 4.9.3, Desktop 1.8.1 »

From the beginning, the Memento wiki was developed and continues to be developed with the assistance of wiki templates developed by ourselves.

To access these templates, go to Main Page > Special Pages > Uncategorized templates.

This page documents each of the templates, how they are used, and I'm some cases, how they are used together.

Template documentation

Note annotations

BeginNote
Initiate a note being taken in a wiki page
EndNote
Finish a note being taken in a wiki page
NoteLine
A single-line independent note

Memento editions & their documentation in the wiki

EditionA
Info on all editions of Memento follows
EditionD
Info specific to the desktop edition follows
EditionM
Info specific to the mobile edition follows

Field type spec support

Standard or default language for field type definition parameters & options

Advanced parameters


Field Data Validation
Documentation is shown in 3 segments: the base (the initial text), the text specific to the field type being documented, and the wrap (the closing text). For example, documentation for a text field is done as follows:
{{FieldDataValidationBase}}
{{FieldDataValidationText}}
{{FieldDataValidationWrap}}

This threesome provides the following standard language:
(Initial text for all data validation fields) FieldDataValidationBase:

Data validation
The value of a field may be validated against user-specified criteria. If the validation fails, an error message is displayed on the screen by the field, and the user must take action to resolve the situation before saving the entry.

(For date fields) FieldDataValidationDate:

After selecting Data Validation, a pop-up will appear for entering validation criteria. For Date & DateTime fields, the input will be deemed valid if:
Today
the date is today.
Yesterday
the date is yesterday.
This week
the date is some time last week.
This month
the date is some time this month.
Last week
the date is some time left week.
Last month
the date is some time last month.
Custom
the date falls between the two dates entered below.
Is empty
the field is empty.
Is not empty
the field is not empty.
This year
the date is some time this year.

(For numeric fields) FieldDataValidationNumeric:

After selecting Data Validation, a pop-up will appear for entering validation criteria. For numeric fields, the input will be deemed valid if:
Less than (default)
its value is less than the value entered below.
Less than (default)
its value is less than the value entered below.
Greater than
its value is greater than the value entered below.
Equal to
its value is equal to the value entered below.
Not equal to
its value is not equal to the value entered below.
Empty
the field is empty.
Not empty
the field is not empty.
Between
its value is between the two numbers entered below.

(For text fields) FieldDataValidationText:

After selecting Data Validation, a pop-up will appear for entering validation criteria. The input will be deemed valid if:
Contains (default)
it contains a string (a sequence of characters) as entered below.
Not contains
it does not contain the string entered below.
Is equal to
it matches the string entered below.
Is not equal to
it does not match the string entered below.
Is empty
it is empty (contains nothing).
Is not empty
it is not empty (contains any characters).

(Closing text for all data validation fields) FieldDataValidationWrap:

If the checkbox is unchecked (default), a standard error message will be displayed when the input is invalid.
If the checkbox is checked, a custom error message will be displayed when the input is invalid.
If the Clear button is pressed, the criteria settings will be cleared.
If the Cancel button is pressed, the criteria settings will not be affected, and the criteria pop-up will be dismissed.
If the OK button is pressed, the input data will be accepted and displayed on the screen after the pop-up disappears.

FieldDepend
merely provides the following standard language:

Dependencies
Ability to add one or more visibility dependencies upon fields with qualifying types.
FieldFont
merely provides the following standard language:
Font
Choices are:
  • Family: Regular, Light, Condensed, Thin, Medium. By default, Regular.
  • Style: Normal, Bold, Italic, Bold Italic. By default, Normal.
  • Size: By default, 18. Direct entry to change.
  • Color: By default, White. Palette of 20 colors, backed up by a continuously variable color chooser.
FieldFontCard
merely provides the following standard language:
FieldNameHint
merely provides the following standard language:
FieldOnCard
merely provides the following standard language:
FieldRequired
merely provides the following standard language:
FieldRoleRND
merely provides the following standard language:
FieldRoleRNDS
merely provides the following standard language:
FieldRoleRT
merely provides the following standard language:

Display Options

FieldTypeReturnValues FieldWhereEdit

Linking sheets

JavaScriptLinks LinkSyncSheets MenuOptionLinkSyncSheets MenuOptionProtection MenuOptionUploadToCloud

Specific

Data & version stamping of wiki pages

Stamp StampD StampM

Miscellaneous

TBD above TBD below