Difference between revisions of "Default templates"

From ICA-AtoM
Jump to navigation Jump to search
(New page: __NOTOC__ <span class="pageTitle">Customize user interface entity labels</span> Main Page > (UM) User manual > UM-7 Administer ICA-AtoM > [[UM-7.3|UM-7.3 Cust...)
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
<span class="pageTitle">Customize user interface entity labels</span>
+
<span class="pageTitle">Specify screen templates</span>
  
−
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-7|UM-7 Administer ICA-AtoM]] > [[UM-7.3|UM-7.3 Customize settings]] > UM-7.3.5 Customize user interface entity labels
+
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-7|UM-7 Administer ICA-AtoM]] > [[UM-7.3|UM-7.3 Customize settings]] > UM-7.3.4 Specify screen templates
  
−
[[Image:um7-3-4Labels.png|500px|right|thumb|Customizing user interface labels]]
+
[[Image:um7-3-3Templates.png|500px|right|thumb|Site settings page with default_templates information area expanded]]
  
  
−
Users of ICA-AtoM interact with four main [[Entity|entities]]: [[Archival description|archival descriptions]], [[Authority record|authority records]], [[Archival institution|archival institutions]], and [[Term|terms]].
+
ICA-AtoM 1.0 beta ships with default screen layouts ("templates") for viewing and editing the [[Database content|database content]]. These layouts are based on ICA descriptive standards: [[RS-1|ISAD(G)]], [[RS-2|ISAAR(CPF)]] and [[RS-3|ISDIAH]].  
  
−
*For more on [[Entity|entities]], see [[UM-1.3|UM-1.3 Entity types]].
 
  
 +
ICA-AtoM, however, is built on underlying software ([http://qubit-toolkit.org/wiki/index.php?title=Main_Page Qubit]) that is designed to be flexible enough to support other archival descriptive standards, as well as other standards for other types of materials (such as library, museum and art gallery materials). Future releases of ICA-AtoM will include other templates based on some of these other standards -- for example, the Canadian ''Rules for Archival Description'' (RAD), the Brazilian ''Norma brasileira de decriçào arquivística'' (NOBRAD), ''Dublin Core'' metadata element set (DC), ''Categories for the Description of Works of Art'' (CDWA) and ''Metadata Object Description Schema'' (MODS).
  
−
ICA-AtoM, however, is built on underlying software ([http://qubit-toolkit.org/wiki/index.php?title=Main_Page Qubit]) that is designed to be flexible enough to support descriptions of other types of cultural materials in addition to archival holdings (such as library, museum and art gallery materials). The code, therefore, uses generic terms for [[Entity|entities]]. [[Administrator|Administrators]] can specify how they want these terms to appear in the [[User interface|user interface]] labels. The default labels that ship with ICA-AtoM represent an archives-specific "theming" of the labels.
 
  
 +
[[Developer|Developers]] can also create their own customized templates and add them to their ICA-AtoM application. This involves, however, dealing directly with the application code and should only be undertaken by programmers familiar with Symfony and PHP.
  
−
1. Click the ''admin > settings'' tab.
+
*See developer documentation at the [http://qubit-toolkit.org/index.php?title=Main_Page Qubit-toolkit website] for adding customized templates to the application.
 +
 
 +
 
 +
The ''site settings'' screen is where [[Administrator|administrators]] specify which templates to use for which [[Entity|entities]] under which actions (e.g. edit an [[Archival institution|archival institution]], list [[Authority record|authority records]]). These procedures assume that you have more than one template for any given entity / action. This is '''not''' the case with the default version ICA-AtoM 1.0 beta; it ships with '''only''' the ICA templates. Use the following procedures '''only if''' a [[Developer|developer]] has created customized templates '''in addition''' to those shipped with ICA-AtoM 1.0 beta.
  
  
−
2. Open the ''ui_label'' [[Information area|information area]].
+
1. Click the ''admin > settings'' tab.
  
  
−
3. The ''name'' column shows the generic qubit [[Entity|entity]] name and the ''value'' column shows ICA-AtoM's default [[User interface|user interface]] labels.  The following is a list of the generic qubit terms and their ICA-AtoM [[User interface|user interface]] labels. Click on each label to see glossary definitions and descriptions of how the terms are used in ICA-AtoM.
+
2. Open the ''default_template'' [[Information area|information area]].
  
−
*'''informationobject''' [[Archival description|archival description]]
 
  
−
*'''actor''' [[Authority record|authority record]]
+
3. The ''name'' column shows the [[Entity|entity]] / action used in ICA-AtoM's software code. Note that names use the generic Qubit terms rather than the archives-specific terminology of ICA-AtoM.
  
−
*'''creator''' [[Creator|creator]]
+
*'''informationobject_edit''': open an [[Edit screen|edit screen]] for data entry for a single information object ([[Archival description|archival description]]).
  
−
*'''repository''' [[Archival institution|archival institution]]
+
*'''informationobject_show''': open a [[View screen|view screen]] for read-only display of a single information object ([[Archival description|archival description]]).
  
−
*'''term''' [[Term|term]]
+
*'''informationobject_list''': display a set of information objects ([[Archival description|archival descriptions]]) on a [[List screen|list screen]].
  
−
*'''subject''' [[Subject|subject]]
+
*'''actor_edit''': open an [[Edit screen|edit screen]] for data entry for a single actor ([[Authority record|authority record]]).
  
−
*'''collection''' [[Fonds|fonds]]
+
*'''actor_show''': open a [[View screen|view screen]] for read-only display of a single actor ([[Authority record|authority record]]).
  
−
*'''holdings''' [[Holdings|holdings]]
+
*'''actor_list''': display a set of actors ([[Authority record|authority records]]) on a [[List screen|list screen]].
  
−
*'''place''' [[Place|place]]
+
*'''repository_edit''': open an [[Edit screen|edit screen]] for data entry for a single repository ([[Archival institution|archival institution]]).
  
−
*'''name''' [[Name|name]]
+
*'''repository_show''': open a [[View screen|view screen]] for read-only display of a single repository ([[Archival institution|archival institution]]).
  
−
*'''digitalobject''' [[Digital object|digital object]]
+
*'''repository_list''': display a set of repositories ([[Archival institution|archival institutions]]) on a [[List screen|list screen]].
  
−
*'''physicalobject''' [[Physical storage|physical storage]]
 
  
−
*'''media type''' [[Media type|media type]]
+
4. The ''value'' column shows the name of the layout template invoked by an [[Entity|entity]] / action. ICA-AtoM ships with the default templates entered here.
  
  
−
4. To change a [[User interface|user interface]] label, enter the new label into the [[field|field]] in the ''value'' column and click on the ''save'' button.
+
5. To change templates, overwrite the name of the in the ''value'' column with the exact name of the template you want to use

Revision as of 17:43, 1 October 2008

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Specify screen templates

Main Page > (UM) User manual > UM-7 Administer ICA-AtoM > UM-7.3 Customize settings > UM-7.3.4 Specify screen templates

Site settings page with default_templates information area expanded


ICA-AtoM 1.0 beta ships with default screen layouts ("templates") for viewing and editing the database content. These layouts are based on ICA descriptive standards: ISAD(G), ISAAR(CPF) and ISDIAH.


ICA-AtoM, however, is built on underlying software (Qubit) that is designed to be flexible enough to support other archival descriptive standards, as well as other standards for other types of materials (such as library, museum and art gallery materials). Future releases of ICA-AtoM will include other templates based on some of these other standards -- for example, the Canadian Rules for Archival Description (RAD), the Brazilian Norma brasileira de decriçào arquivística (NOBRAD), Dublin Core metadata element set (DC), Categories for the Description of Works of Art (CDWA) and Metadata Object Description Schema (MODS).


Developers can also create their own customized templates and add them to their ICA-AtoM application. This involves, however, dealing directly with the application code and should only be undertaken by programmers familiar with Symfony and PHP.

  • See developer documentation at the Qubit-toolkit website for adding customized templates to the application.


The site settings screen is where administrators specify which templates to use for which entities under which actions (e.g. edit an archival institution, list authority records). These procedures assume that you have more than one template for any given entity / action. This is not the case with the default version ICA-AtoM 1.0 beta; it ships with only the ICA templates. Use the following procedures only if a developer has created customized templates in addition to those shipped with ICA-AtoM 1.0 beta.


1. Click the admin > settings tab.


2. Open the default_template information area.


3. The name column shows the entity / action used in ICA-AtoM's software code. Note that names use the generic Qubit terms rather than the archives-specific terminology of ICA-AtoM.


4. The value column shows the name of the layout template invoked by an entity / action. ICA-AtoM ships with the default templates entered here.


5. To change templates, overwrite the name of the in the value column with the exact name of the template you want to use

Retrieved from "https://wiki.ica-atom.org/index.php?title=Default_templates&oldid=5935"