MetaData configuration

DocMoto allows users to mark files and folders with various metatags. These metatags can then be used when searching and ordering. For example a user may wish to use a metatag to show the size of images. This could then be used as a way to search for images of a particular size, or to order images by size in the folder pane. Through the use of xml configuration files, DocMoto allows administrators the ability to fully customise tags available to the user.

Default Tags

DocMoto has a default set of tags to allow users to quickly set up projects, however administrators may find the need to add extra tags.These defaults can be seen when viewing a folders properties.

 

Adding New Meta Tags

Meta tags are defined in xml files contained within the DocMotoConfig/MetaTags folder. Once a tag has been defined it may be used for both folder and document tags and can be viewed using the folder columns and the info panel.

To create a new metatag either append an existing metatag file, or create a new one. The following is an example of a metatag file which declares one tag:

<?xml version="1.0"?>
<dm:MetaTagDefinition
xmlns:dm="http://www.docmoto.com/2008/03/uiconfig">

<dm:metatag tag="tagname" displayname="Tag Display Name" type="builtin:string" editable="true" />

</dm:MetaTagDefinition>

Note: Throughout this document dm refers to the namespace "http://www.docmoto.com/2008/03/uiconfig"

Syntax
<dm:metatag (tag, displayname, type)/>

Attribute list
tag ::= How the tag will be referenced
displayname ::= How the tag will be displayed to the user
type ::= either a builtin value, or a custom type as declared elsewhere in the file

builtin types:

  • string
  • integer
  • decimal
  • date
  • filesize
  • username

Advanced Use: The input can be restricted using masks. However if there will be multiple metatags using the same input data a custom type should be used instead.

Masking input data:
<dm:string (regex="")/>
<dm:integer (min, max)/>

Adding New Tag Types

Tag types should be declared when more than one metatag uses the same syntax / values.

PICKLIST

Picklists are used to force the user to select an option from a pre-defined list QUESTION 1

Example picklist

<dm:picklist name="picklist1" default="not set">
   <dm:value allow="false">not set</dm:value>
   <dm:value>Selection A</dm:value>
   <dm:value>Selection B</dm:value>
   <dm:value>Selection C</dm:value>
</dm:picklist>

Syntax
<dm:picklist (name, default)>
<dm:value(allow, icon)>VALUE</dm:value>

Attribute list:
name ::= (string) name of picklist, used when declaring tags
default ::= (string) default value (note, default value may not be a valid selection, this will force the user to select a valid value
allow ::= (boolean) Defines if the selection is valid
icon ::= (.ico) name of icon file, used when displaying list for user

TYPEDEF

Typedef is used to create a custom value type.

Example typedef

<dm:typedef name="emailAddress">
    <dm:string regex="[\l\u\d._%+-]+@[\l\u\d.-]+\.[\l\u]{2,4}"/>
  </dm:typedef>

Syntax (String)
<dm:typedef (name)>
<dm:string (regex="")/>
</dm:typedef>

Attribute list:
name ::= (string) name of tag
regex ::= Regex is a Perl compatible regular expression with assumed $ around it

Syntax (Integer)
<dm:typedef (name)>
<dm:integer (min, max) />
</dm:typedef>

Attribute list:

name ::= (string) name of tag

min ::= (integer) minimum value

max ::= (integer) maximum value

Copyright 2013 CHLSoftware. All rights reserved. All trademarks acknowledged.