Configuring ewok
================
h2: ewok core configuration =#core
TODO
- ewok.conf - apache configuration file for ewok
- Config.pm - main ewok configuration file
h2: Configuring publishing =#publish
Short answer:
- copy EWOK_HOME/publish.map.dist to EWOK_HOME/publish.map
- edit to taste - the example should be fairly well commented
- things to watch out for:
- make sure you change the head of the whole entry (e.g. '/home/httpd/stage'
as well as the items within each entry
- if you're using the same apache for both the staging and publishing sides
then set 'dest_web_dir'; if you're using different apaches comment it out
unless you know the publish directory is also available within the staging
apache's namespace (generally requires it be on local or network shared
disk)
- make sure the file ends up as valid perl code - do a 'perl -c publish.map'
afterwards to check
TODO: better version
- see /ewok/publish.map
- not inherited (i.e. edit the /ewok/publish.map version)
- fairly well-commented
h2: Configuring metadata =#metadata
Note: the metadata map format is likely to change in the near future.
Be aware that you will probably have to redo any customisations you make in
that event.
The metadata that can be set for various ewok entities (files, directories, etc.)
is defined in the *metadata.map* file. This map is inherited in the same way as
templates, so that for site-specific customisation it often makes sense to make a
copy of the system-wide /ewok/metadata.map at the top of your site tree, and
modify the copy.
To add your own metadata:
- Open the appropriate metadata.map for editing. Metadata maps are made up
of multiple entries corresponding to an object type (file, directory, user,
etc.), with each entry containing definitions of the individual metadata
items for that object type.
- Locate the map entry you want to modify. Entries are either literals (ewok
currently understands 'user', 'dir', and 'file') - or regular expressions on
filenames. For files, ewok uses the map entry with the longest regular
expression matching the current filename, and falls back to the 'file' entry if
there are no matches.
The map that ships with ewok has a regex entry of 'html?|xml', allowing additional
metadata to be stored for HTML and XML files.
- Add or remove metadata item definitions. Definitions can be commented out by
using a '#' at the beginning of the line.
Metadata item definitions have the following form:
metadata_item => {
datatype => <datatype> ,
fieldtype => OPTIONAL\|MANDATORY ,
[priv => <privilege> ,]
[inherit => 0|1 ,]
[omit => 0|1 ,]
[hidden => 0|1 ,]
},
Attributes are defined as:
- datatype:
- BOOLEAN
- TEXT ('text' html field)
- TEXTLONG ('textarea' html field)
- PASSWORD ('password' html field)
- INTEGER
- FLOAT
- an enumerated list, defined as a text string enclosed in quotes with entries
separated by vertical bars (|) e.g. 'male | female' or
'under 20 \| 20-30 \| 31-40 \| over 40'
- SYSTEM - metadata created and maintained by ewok itself (currently
'create_dtm' and 'creator')
- fieldtype: whether the field is optional or mandatory
(NOT YET IMPLEMENTED)
- privilege: (optional) the minimum user privilege level for whom the item
should be visible/editable ('admin', 'templates', 'permissions', 'publish',
'edit' - see "The ewok user model":../user/users.html)
- inherit: (directory metadata only) whether this item should be inherited
by subdirectories
- omit: whether this field should be omitted from the default metadata
listing, and shown only when the user chooses "Show all fields"
- hidden: specifies that this item should never be displayed (mostly useful
with SYSTEM metadata)
- Save your changes. ewok should notice the changes immediately and reload
its metadata maps.