dots-vue settings

[vicpsl]

DoTS-vue settings documentation

Although DoTS-vue has been designed to read and display any DTS API (Distributed Text Services), its default setup may not be fully operative depending on the sources and may require some customisation to take advantage of its functionalities.

This documentation describes the settings workflow and available options for customisation.

1. Default settings

1.1 Environment variables

Name	Status	Description
VITE_APP_DTS_ENDPOINT_URL	Mandatory	Targeted DTS API endpoint url Ex: https://dev.chartes.psl.eu/dots/api/dts
VITE_APP_ROOT_DTS_COLLECTION_ID	Mandatory (default: empty string)	Targeted root collection in the endpoint (root collection of a DTS API if blank) : Ex: elec for https://dev.chartes.psl.eu/dots/api/dts (root collection at https://dev.chartes.psl.eu/dots/api/dts/collection)
VITE_APP_APP_ROOT_URL	Mandatory (default: /)	Mountpoint of the dots-vue app Ex: / for a deployment at http://localhost:5173/ /my_subdomain for a deployment at http://localhost:5173/my_subdomain/
VITE_APP_DOCUMENT_ROUTE _INCLUDE_PROJECT_ID	Mandatory (true/false)	A boolean indicating if dots-vue will update routes based on sub-collections ids Ex: for a project with id ENCPOS containing subcollections ENCPOS_YYYY for several years (YYYY): - if true, urls will be: http://localhost:5173/ENCPOS and http://localhost:5173/ENCPOS_YYYY - if false, urls will be: http://localhost:5173/ENCPOS even for subcollections (ENCPOS_YYYY) for any year YYYY
VITE_APP_CUSTOM_SETTINGS_PATH	Optional (${CUSTOM_SETTINGS_PATH})	Relative path between the app folder (/dots-vue) and a custom collection settings folder if any Pass the ${CUSTOM_SETTINGS_PATH} variable in front of yarn commands: Ex: CUSTOM_SETTINGS_PATH=../dots-vue-elec-settings yarn serve (where /dots-vue-elec-settings and /dots-vue have the same parent folder)

1.2 Default app settings

Default app settings are available in the /assets and /settings folders of the app, respectively:

• /assets:
  • /css: default css for the app
  • /images: default images and logos for the app
• /settings: default parameters for the root collection, projects (level 1 collections of the root) and any other collections, unless otherwise defined in a custom collection settings folder (see VITE_APP_CUSTOM_SETTINGS_PATH above)
  • /default: a default homepage vue component offering several presentation options for the collection homepage(s)
  • default.conf.json: a default json object offering several presentation options for the collection(s)

1.3 Focus on the default collection settings (/settings/default.conf.json):

JSON Key Path	Data Type	Description	Default Value	Illustration / Notes
genericConf	Object	Default collection settings	{...} (object)	Root object containing configuration sections
genericConf mediaTypeEndpoint	String	Type of response expected from the DTS API &mediaType= parameter ("tei" or "html")	"tei"	"tei" indicates TEI XML format response
genericConf .homePageSettings	Object	Settings related to the collection(s) home page	{...} (object)	See 1.3.1
genericConf .footerSettings	Object	Footer related settings	{...} (object)	See 1.3.2
genericConf .tableOfContentsSettings	Object	Settings for table of contents	{...} (object)	See 1.3.3
genericConf .aboutPageSettings	Array of Object	Settings for about page tabs	3 objects	See 1.3.4
excludeCollectionIds	Array	List of collection IDs to exclude	[]	Empty array

1.3.1 Homepage settings (genericConf.homePageSettings):

The homePageSettings object allows to customize several default collection(s) home page components:

JSON Key Path	Data Type	Description	Default Value	Illustration / Notes
genericConf .homePageSettings .collectionsPerPage	Number	Number of collections to show per page	3	Limits pagination to 3 collections
genericConf .homePageSettings .collectionAltTitle	String	Alternative title for the collection	""	DTS API Title when not provided
genericConf .homePageSettings .collectionShortTitle	String	Short title of the collection	""	DTS API @id when not provided
genericConf .homePageSettings .collectionDescription	String	Description of the collection	""	DTS API Description when not provided
genericConf .homePageSettings .customCollectionDescription .compName	String	Vue component name used for custom collection description	"HomePageContent"	A paragraph with the DTS API Description or .collectionDescription when not provided
genericConf .homePageSettings .appNavBarLogo	Object	Logo settings for app navigation bar	{...} (object)	Contains image name and href
genericConf .homePageSettings .appNavBarLogo .imgName	String	Navbar logo image file name	"Logo_dots_circle.svg"	Default logo image file
genericConf .homePageSettings .appNavBarLogo .href	String	Navbar logo link	"/"	Default link to home
genericConf .homePageSettings .appNavBarApiLogo .imgName	String	Navbar API logo image file name	"API {}"	Defaults to "API {}" when not provided
genericConf .homePageSettings .appNavBarApiLogo .href	String	Navbar Api logo link	"/"	Default link to home
genericConf .homePageSettings .logo	String	Thumbnail or logo image name (collection cards view)	""	Defaults to /assets/images/dots-logo-retro.drawio.svg

[architexte]

Mémo

• VITE_APP_APP_ROOT_URL: useful ? keep ?
• VITE_APP_DOCUMENT_ROUTE_INCLUDE_PROJECT_ID: rethink behavior
• VITE_APP_THEME: define or delete