E <      ^ R    MICHAEL Documentation > Editor's Guide > Getting started >                    

 

Browsing the database

2005-04-04 / 2005-06-10

A MICHAEL database is organised with folders. An editor don't absolutely needs to create new folders, but he or she must know how to browse through folders and what are the default folders of a MICHAEL database.

1) Browsing through folders

In any MICHAEL database, there is a root folder containing other folders, themselves containing documents and other folders, etc. Browsing through this hierarchical structure is done largely like in Yahoo! or similar sites:

In order to browse quickly, you need to understand the general structure of the viewing pane in the MICHAEL production module. Here is an example viewing pane:

This viewing pane is visible in all pages except:

This pane contains three zones, explained here from top to bottom:

Context
This zone first contains links to go to your personal homepage and to go to your home folder (not documented yet). Then you will find links to all the parent folders of the current folder, which give you the context of your current folder. This context is followed by the current folder's name. In the example above, the current folder is Project , contained in the folder Records , contained in the folder MICHAEL Data , contained in the root folder of the database. You can browse to any of these parent folders by clicking on their name.
List of sub-folders
You will find there a list of all sub-folders of the current folder. You can browse to any of these sub-folders by clicking on its name. In the example above, there is only one sub-folders, its name is East Midlands .
Documents
This third zone contains a list of all documents contained in the current folder. You can view the document by clicking on its name, you can modify it by clicking on the first icon to the left, the Modify icon.

The _meta.xml file is a special file that contain the current folder's metadata; you can edit it to change the folder's name.

2) Creating a new folder and deleting folders

To create a new folder, first browse to the folder that will contain it. Once there, click on the Create sub-folder button before the list of current sub-folders:

You will then get a form to enter the code and the complete name of the folder:

The code must be unique within the current folder. Please use only ASCII letters, digits, - and _ in your folder codes .

The complete name can be defined for multiple languages, you should at least create a significant name for the default language of the user interface for your MICHAEL instance.

Once done, click on the Save data button and this will create the folder.

To delete a folder, just check the box in front of the folder name when you see it in the viewer and then click on the delete icon below the list of folders:

Be careful! By doing so, all folder content will be deleted, including sub-folders and their content!

3) Default folders of a MICHAEL database

A standard MICHAEL database has standard folders; in order to make sure that everything works correctly, the codes of these folders must not be changed. Please note that you can change the complete names of these folders if you wish.

In the following list of standard folders, we give first the path with codes, then with standard English complete names.

Code

Complete name

Description

/mpf
MICHAEL Data
All MICHAEL data, except lists.
/Lists
Lists
Lists used in forms.
/mpf/records
MICHAEL Data > Records
All MICHAEL records.
/mpf/slide-shows
MICHAEL Data > Slide shows
All MICHAEL slide-shows (feature not documented yet)
/mpf/records/digital-collection
MICHAEL Data > Records > Digital collections
All MICHAEL digital collection records
/mpf/records/institution
MICHAEL Data > Records > Institutions
All MICHAEL institution records
/mpf/records/physical-collection
MICHAEL Data > Records > Physical collections
All MICHAEL physical collection records
/mpf/records/project
MICHAEL Data > Records > Projects
All MICHAEL project or programme records
/mpf/records/service
MICHAEL Data > Records > Services
All MICHAEL service or product records

The shortcuts in your personal homepage work based on this standard structure of folders. Other structures would be possible with some simple customization of the platform.