doctype corresponds to the Tamino doctype for the schema. When you define a schema in Tamino you must specify the doctype and it is generally the top level element in the schema e.g. in bil /Project, and in mpcol /parry. The ted:doctype markup should be specified as the first piece of ted markup in the schema. searchindex specifies the search index for simple search. searchindex is specified as one or more paths The path is the path to the element in the schema. This path should be relative to the doctype - it should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:searchindex="/record" or e.g. ted:searchindex="record" or e.g. ted:searchindex="//record" If the simple search index is the doctype, use a dot for the path e.g. ted:searchindex="." If the search occurs in multiple indexes, use the following syntax: ted:searchindex=". Project_Description/@projectID" advancedsearchboolean specifies the number of boolean options The maximum number of booleans is 5. If the number of booleans is set to 2, 3 text input boxes are displayed in the user interface and 2 drop down menus with "and, or, not, near" options. advancedsearch indexes are specified as name|path(s) pairs. index pairs are separated by , index name and path(s) are separated by | The name is the name of the index. This name is displayed on the results screen when displaying the executed query to the user. This name may include spaces. The path is the path to the element in the schema. This path should be relative to the doctype - it should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:advancedsearchindex="Anywhere|/record, Singer|/record/singer/name" or e.g. ted:advancedsearchindex="Anywhere|record, Singer|record/singer/name" or e.g. ted:advancedsearchindex="Anywhere|//record" If the path to the index in the schema is the same as the doctype use . as the path. e.g. ted:advancedsearchindex="Anywhere|." If the search index maps to more than one path in the schema, multiple paths should be separated by spaces. e.g. ted:advancedsearchindex="Title|/record/title /record/translatedTitle /record/alternateTitle" dropDownLimits are specified as name|path|value tuples dropDownLimit tuples are separated by , dropDownLimit name, path and value are separated by | The name is the name of the limit that appears on the search interface. This name will be automatically preceded by "Limit by " text in the interface. The name may include spaces. The path is the path to the element in the schema. This path should be relative to the doctype - it should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:dropDownList="Collection Method|record/collectionMethod|/autograph/copied/dictated/recorded" or e.g. ted:dropDownList="Collection Method|/record/collectionMethod|/autograph/copied/dictated/recorded" or e.g. ted:dropDownList="Collection Method|//collectionMethod|/autograph/copied/dictated/recorded" The value is the list of values that appears in the dropdown in the user interface. A "No Limit" option gets added automatically to the top of the drop down list by TED so it is not necessary to specify "No Limit" in the list of values. These values are separated by / e.g. ted:dropDownList="Collection Method|/record/collectionMethod|/autograph/copied/dictated/recorded" The dropDownLimitLabel specifies text that is associated with a particular limit. The text gets added immediately after the drop down limit list in the interface. dropDownLimitLabels are specified as name|value pairs. dropDownLimitLabel pairs are separated by , The name must be equal to the dropDownLimit name specified in the dropDownLimit (see definition above). The value is free text. e.g. ted:dropDownLimitLabel="Collection Method|Here is a collection method label, Collection|Here is a collection label" checkBoxLimits are specified as name|path|value tuples or as name|path pairs checkBoxLimit tuples or pairs are separated by , checkBoxLimit name, path and value are separated by | The name is the name of the check box limit that appears on the search interface. The name may include spaces. The path is the path to the element in the schema. This path should be relative to the doctype - it should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:checkBoxLimit="Digital Audio|/record/audio/digitalAudio or e.g. ted:checkBoxLimit="Digital Audio|record/audio/digitalAudio or e.g. ted:checkBoxLimit="Digital Audio|//digitalAudio If the limit is limited to an element with a single value, this represents the value. Example of a pair: ted:checkBoxLimit="Digital Audio|/record/audio/digitalAudio, Digital Text|/record/:text/digitalText" Example of a tuple: ted:checkBoxLimit="Digital Images|/@images|true" The checkBoxLimitLabel specifies text that is associated with a particular limit. The text gets added immediately after the check box in the interface. checkBoxLimitLabels are specified as name|value pairs. checkBoxLimitLabel pairs are separated by , The checkBoxLimitLabel name must be equal to a checkBoxLimit name specified in the checkBoxLimit (see definition above). The value is free text. e.g. ted:dropDownLimitLabel="Digital Audio|Here is a digital audio label, Digital Text |Here is a digital text label" browseindexes are specified as name|path pairs. browse index pairs are separated by , browse index name and path are separated by | The name is the name of the browse index. The name is displayed in the drop down list on the browse screen. The name may include spaces. The path is the path to the element in the schema. This path should include the doctype and should have a leading slash. e.g. ted:browseindex="Title|/Project//Title, Subject|/Project//Subject" e.g. ted:browseindex="Common Name|/mczArtwork/specimen/commonName" If the browse indexes map to more than one path in the schema, the multiple paths should be separated by spaces. e.g. ted:browseindex="Title|/parry/record/title /parry/record/alternateTitle /parry/record/translatedTitle resultsdisplay specifies the items displayed in the results display. resultsdisplay are specified as name|path pairs. result display pairs are separated by , result display name and path are separated by | The name is the name of the element displayed. If there is no additional ted markup adding a ted label to the element, a pretty print version of this name gets displayed in the results display. The path is the path to the element in the schema. This path should include the doctype and should have a leading slash. e.g. ted:resultsdisplay="Project|/Project/Project_Description/Title, Abstract|/Project/Project_Description/Abstract" If any element in the path contains multiple values, use the subscript notation e.g. ted:resultsdisplay="ItemNumber|/parry/record/itemNumber[1], Singer|/parry/record/singer[1]/name" saverecord specifies what elements can be saved from the full record display saverecord is specified as one or more paths saverecord paths are separated by , The path is the path to the element in the schema. This path should include the doctype and should have a leading slash. e.g. ted:saverecord="/Project, /Project/Datasets//Image_Stack" e.g. ted:saverecord="/parry/record" defaultSave specifies what other parts of the record are saved by default when you save a component of the record in the clipboard. If the records are small this may not be necessary. defaultSave is specified as one or more paths defaultSave paths are separated by , The path is the path to the element in the schema. This path should include the doctype and should have a leading slash. e.g. ted:defaultSave="/Project/Project_Description/Title, /Project/Project_Description/Abstract" instanceLabel is the label attached to objects stored in the clipboard. instanceLabel is specified as one or more paths instanceLabel paths are separated by , The path is the path to the element in the schema. This path should include the doctype and should have a leading slash. e.g. ted:instanceLabel="/Project/Project_Description/Title" e.g. ted:instanceLabel="/parry/record/title, /parry/record/itemNumber" resultsChoice specifies operations available to refine a search. These options are available from a dropdown list in the search interface. Currently the text associated with these operations is generic to TED and cannot be customized. resultsChoice can be set to one of the following constants 1. addResults adds the results of the query to the existing result set e.g. ted:resultsChoice="addResults" 2. withinResults searches within the existing result set e.g. ted:resultsChoice="withinResults" 3. removeFromResults removes the results of the query from the existing result set e.g. ted:resultsChoice="removeFromResults" 4. to include addResults, withinResults and removeFromResults specify all e.g. ted:resultsChoice="all" defaultRecordDisplay specifies how results should be displayed in the full record display. If no value is selected, it will default to displayHits. defaultRecordDisplay can be set to one of the following constants 1. collapse mode displays a collapsed tree. The user will need to expand parts of the tree to view the data. e.g. ted:defaultRecordDisplay="collapse" 2. expand expands the tree completely so that the user can see all elements. If the expanded tree is very large, this option should be avoided as it may be slow. e.g. ted:defaultRecordDisplay="expand" 3. displayHits expands the parts of the tree where the search terms are found and highlights the search terms. e.g. ted:defaultRecordDisplay="displayHits" If defaultRecordDisplay markup is not specified, the record display defaults to displayHits. Dates in TED collections can be represented as follows: a. Using the xs:date schema construct in this format: YYYY-MM-DD (Milman Parry) b. Using the xs:integer schema construct if only the year information is available - the integer should be in YYYY notation. (VIA) If the date uses the YYYY-MM-DD format, date search options 1-6 are available and are presented as follows in the search interface "Date(s) From: YYYY (Input box) MM (Input box) DD Through: YYYY (input box) MM (input box) DD (input box). If the user only enters a From YYYY value, the Through YYYY will default to From YYYY + 1 All other values will default to 01. If the date is represented as an integer, options 1 and 4 are available and are presented as follows in the search interface "Date(s) From: YYYY (Input box) Through: YYYY (input box). If the user only enters a From YYYY value, the Through YYYY will default to From YYYY + 1 Date options 1. fromDateYear 2. fromDateMonth 3. fromDateDay 4. throughDateYear 5. throughDateMonth 6. throughDateDay For xs:date YYYY-MM-DD format e.g. ted:dateSearch="fromDateYear, fromDateMonth, fromDateDay, throughDateYear, throughDateMonth, throughDateDay" For xs:integer YYYY format e.g ted:dateSearch="fromDateYear, throughDateYear" A date index specifies the path in which the date search will occur. dateindexes are specified as paths separated by , The dateIndex can be in a single date or a date range, in which case the start and end date are separated by spaces. Single dates contain the path to the date in the schema. A date range contains the path to the start date and end date in the schema. The paths should be relative to the doctype - they should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:dateIndex="/record/date/singleDate" or e.g. ted:dateIndex="/group/structuredDate/beginDate /group/structuredDate/endDate, group/subwork/structuredDate/beginDate /group/subwork/structuredDate/endDate" This single date query gets transformed into /parry[((record/date/singleDate lt;= 1933-01-01 and record/date/singleDate >= 1932-01-01))] The start and end date query gets transformed into /viaRecord[((group/structuredDate/beginDate lt;= 1882 and group/structuredDate/endDate >= 1880) or (group/subwork/structuredDate/beginDate lt;= 1882 and group/subwork/structuredDate/endDate >= 1880))] numberSort specifies the number of sorts that should be available in the user interface. If you do not want to include a sort option, omit the numberSort markup. Sorting involves post processing, so it would be best to minimize the number of sort options. sortIndexes are specified as name|path pairs. sortIndex pairs are separated by , sortIndex name and path are separated by | The name is the name of the index. This name is displayed in the sort drop down list. This name may include spaces. The path is the path to the element in the schema. This path should be relative to the doctype - it should not include the doctype. TED will accept paths that start with and without leading slashes. TED will accept paths with double leading slashes. Leading double slash queries are expensive to process and should only be used where necessary - the preferred approach is to use the full path. e.g. ted:sortIndex="Singer|record/singer[1]/name" or e.g. ted:sortIndex="Singer|/record/singer[1]/name" or e.g. ted:sortIndex="Singer|//name" The sort value needs to be unambiguous. If an element is repeatable, Tamino will detect a duplicate in the sort key and will be unable to perform the sort. In this case the subscript notation should be used e.g. ted:sortIndex="Singer|record/singer[1]/name, Title|record/title[1], Location|record/location[1]" A default sort indexed can be specified. Because sort involves post-processing, adding a default sort may add extra processing time. However, for smaller collections it can be a very useful tool. The default sort value is any name defined in the sortIndex. If the sortIndex = Singer|record/singer[1]/name, Title|record/title[1] then ted:defaultSort="Singer" or ted:defaultSort="Title" Added specifically for via. Identifies the components of a record that can be independently displayed and saved. Note that when displaying or saving a chunk, information from up the tree is usually included as well. e.g. ted:chunks="/viaRecord, /viaRecord//subWork, /viaRecord//surrogate, /viaRecord//image" Allows specification of pre-defined actions for marked-up elements. - replaceRef tells display to replace entityRefs with targets; The asynch deliverable requires the stated action rather than simple delivery. The marked item is deliverable through the asynch; its form is specified as one of the enumerated types. Specifies the name to be used by the asynch when it builds the folder branch for this div. This markup is only meaningful for elements bearing asynch=div markup. Value must be the name of an attribute or direct child of the div element; the contents of this name element will be used as the div name. By default xdom uses the element name as the label; this can be overridden with the label attribute. Controls pagination of the display; a value of "new" tells the editor/maintenance system to break to a new page on the marked-up element. No other values are currently recognized. Used by the editor/maintenance system to plug in a custom class to handle the marked-up element or attribute. Use the java class name. Used by the editor/maintenance system to plug in a custom view to handle the marked-up element or attribute (in terms of MVC pattern) -- typically used together with page="new". Use the java class name. Used by the editor/maintenance system to control which elements are displayed depending on role of the user. Default is "user". "System" role will see everything; "owner" role will see everything except system elements; "user" will see everything except system or owner elements. Use this tag to specify a custom value for the number of rows for the text input area for this marked-up element or attribute.(Used by the display/maintenance system.) Use this tag to specify a custom value for the number of columns for the text input area for this marked-up element or attribute.(Used by the display/maintenance system.) Used together with "entityRef" by the display/maintenance system to manage primary key constraints within a document. See entity management section in xdom javadocs: http://ois.harvard.edu/developer-doc/javadoc/xdom/edu/harvard/hul/ois/xdom/package-summary.html#package_description See documentation for entityKey. Used by the editor/maintenance system to determine what help text should be displayed for the marked-up element or attribute. Like "view", used by the editor/maintenance system to plug in a custom view for the marked-up element; this provides a facility for an alternate view, when multiple views are desired. Use the fully qualified java class name. Provides a presentation label used by the UI to provide access to this view. Use this tag to specify a schema substree that should be culled when loading an instance document. Currently, the value of the attribute is arbitrary; culling is indicated merely by the existence of the attribute. fromHeadingSearches are specified as type|path(s) pairs. Types correspond to the element(s) from which the values to be searched are drawn, as expressed in programming for each DB (i.e., they are not schema-defined). For VIA, these types (as of 5/18/2003) were Name and Place. The path(s) is/are the location of the elements to be searched in the schema. Type and path(s) are separated by | Each fromHeadingSearch pair is separated by ,