Document Properties

Help with the MKDoc document properties page that can be accessed by a document editor and is used for creating and modifying documents.

Editor Menu

If you are editing an existing document then the top of the page will have a menu like this:

If you are creating a new document then you will have a menu like this:

Whichever menu you have out of the two above, the data you have entered will be committed when you submit the form.

Mandatory Metadata

The compulsory document metadata fields on the document properties page look like this (the new document properties page is the same except there is no URI Name option):

All the mandatory metadata form fields must be completed in order for a form submission to be sucessful.

Title

This is for the document Title. It is the name of the document.

URI Name

This is for the name that gets used in the web address for the document. When a new document is created the URI Name value is automatically generated from the document Title. It can subsequently be edited on the document properties page.

Description

This is for an abstract Description of the document, which should make sense if read out of context.

Keywords

This is for, comma seperated, Keywords and subjects which describe the document.

Language

This is for the language that the document is written in.

Optional Metadata

This is what the optional metadata form fields look like in the document properties and create new document properties page:

The Optional Metadata form fields can be left blank. The default values for the Rights and Publisher fields are inherited from the documents partent document at the time of document creation.

Rights

The Rights field is for any copyright notice that needs to be attached to the document.

Publisher

The publisher field is for the name and details of the organisation which has published the document.

Properties

This is what the document properties form elements look like on the document properties and new document properties pages:

The Properties options, Template and Cache-Control can generally be left at their default values.

Template

The Template select list is generated from the available templates for formatting the MKDoc document. When a new document is created its Template is initially the same as the parent document.

Cache-Control

The Cache-Control select list allows you to select the lifespan of the public view of the document before the document is regenerated. The MKDoc editor interface is not affected by this since it is not cached.