Skip to content

Main HTML files

Jump to bottom
Dario Kampkaspar edited this page Mar 2, 2023 · 5 revisions

Main HTML files

files in $approot

entity.html

This file will be included via AJAX if additional information for an “entity” is to be displayed. Here, entity is to be understood as ”POKb” (German: Personen, Orte, Körperschaften, bibliographische Angaben – “persons, places, organizations, bibliographic data”) for which additional information is supplied from an index file or external source.

Template: page2.html

index.html

Serves as the main point of entry by displaying an inventory of all projects currently present in the instance. It is assumed, that every project uses a wdbmeta.xml and that every wdbmeta.xml describes a project. Thus, subprojects are recognized. Projects that solely rely on a mets.xml will be recognized and displayed, too. Subporjects for a METS-project are not supported, though.

Template: page2.html

query.html

A wrapper page for XQuery scripts that should display their input or result via the templating system. See the page on project specific setting for more detail on how to use this.

Template: function.html

search.html

Does roughly the same as query.html but is made especially for search pages. It wraps input/output for full text searches and includes some help.

Template: function.html

start.html

This file is to be called with an ID parameter pointing to the project: {$edocBaseURL}/start.html?id=projectID. It will display a start page for that project. By default, this will be the navigation as defined by wdbmeta.xml on the left and a generic title page on the right. For more information on how to customize the rendering of start.html, see start.html.

Template: function.html

view.html

The main entry point to display an HTML representation of an XML file in any project.

Template: layout.html

Description of basic layout

layout.html

  • 100% width header (fixed)
  • below at initially 50% width each main (left), aside (right)
  • main and aside may contain a (globally defined or project specific) footer

function.html

  • 100% width header (fixed)
  • below aside (left) 30% width, main (right) 70% width
Clone this wiki locally