The glossary defines the terminology we use in WebHare's technical documentation or want to move to to make documentation less confusing
The glossary
- Base fields: WHFS Object fields which are always available, such as name and title.
- Custom fields: Fields added by modules. Usually specific to a webdesign or file/folder type specific. Grouped into WHFS Types
- File Type: A WHFS Type which has been enabled as a file type for WHFS Objects
- Foreign folder: Contains a part of the site that is managed elsewhere (eg. a different site). A foreign folder actually only serves a marker that no CMS content should be published starting from this point as it would conflict with content managed elsewhere
- Instance: An instance of a WHFS Type. Widgets are instances that can render themselves as a widget
- Publisher: The content management system (CMS). Users manage sites, files and folders through the Publisher
- Property: A setting on a (form or Tollium) component.
- Resource: A file shipped as part of a module
- Resource path: Thet path to a resource, generally in the format
mod::<modulename>/<file path>
which will then resolve to a disk path such as/opt/whdata/installedmodules/[customer or group]/<module>/<file path>
. - RTD: Rich Text document. Structured according to a defined RTD Type (ie, heading, paragraphs, widgets but no random DIVs or markup in the data)
- RTD Type: Describes which tags/classes/styles are available in a RTD.
- Site: A WHFS folder that is the starting point for a site and publishes to a URL. Sites cannot contain other sites (except indirectly by using a foreign folder)
- Value constraints: Constraints on the value returned by a Tollium component, or the value allowed to be stored in a field. In siteprofiles properties overwrite each other but constraints are merged
- WHFS: WebHare File System. A hierarchical store usually accessed through the Publisher application
- WHFS File: A file stored in WHFS
- WHFS Folder: A folder stored in WHFS. Contains other files and folders
- WHFS Object: A file or folder in the WHFS.
- WHFS Type: A named group of custom fields used to store custom data in WHFS. A type's name is usually a XML namespace
Meta types:
WHFS Types have a meta type which classifies the features available on or to a WHFS type:
- instance: A plain instance used to extend existing objects with additional properties. (formerly 'content type')
- dataFile: A dataFile combines properties into a single file but cannot be downloaded or published.
- upload: A filetype that has 'raw' content that can be uploaded and downloaded, eg a PDF, Word Document or HTML file
- page: "A filetype whose content/properties are fully managed in WebHare and is usually managed in a (draft/publish) workflow"
- blockWidget: A top-level RTD widget
- inlineWidget: An inline RTD widget (can be embedded into paragraphs)
- folder: A folder stores other folders and files.
Dubious terms
Terms we should avoid (always or in some contexts)
- Content type: Do not use. Refers to either WHFS Types or to a MIME type
- Property: Do not use in the context of WHFS Type members. Just call them (custom) fields. Tollium components do have properties... and both field and fields editors can directly or indirectly (value constraints) override these properties
- Metadata: A lot of things are metadata. And even metadata (custom fields) can have metadata (who changed it? where?). In the document editor we visually distinguish 'Content' (the main area) vs 'Metadata' (the tabs on the side). The WHFS object properties dialog generally only edits metadata. Metadata is probably reasonably clear to the end user (the things on the Metadata tab) but can be confusing internally.
Some fields such as SEO Title live in a bit of a grey area... to end users and siteprofile builders, they are base fields - they are at the top of the metadata and are controlled through the baseFields
(<baseproperties>
). But technically
they are implemented as custom fields. And the distinction between which base fields are stored into fs_objects
and which are stored as custom fields has mostly to do with which fields happened to be considerend relevant in 1999