0.1.3 • Published 9 months ago
dtoc v0.1.3
Dynamic Table of Contexts 2.0
This project is based on Voyant Dynamic Table of Contexts and aims to be an independent and more robust iteration.
Installation
- Get the files
- Either add as a dependency:
npm i dtoc - Or download:
https://registry.npmjs.org/dtoc/-/dtoc-0.1.2.tgz
- Either add as a dependency:
- Copy files to a directory in your workspace
- Initialize and provide a configuration object
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="./lib/ext/ext.js"></script>
<script type="text/javascript" src="./lib/saxon/saxon.js"></script>
<script type="module" src="./dtoc.min.js"></script>
<link rel="stylesheet" type="text/css" href="./lib/ext/ext.css" />
<link rel="stylesheet" type="text/css" href="./css/dtc.css" />
<script src="https://kit.fontawesome.com/891f15ee2f.js" crossorigin="anonymous"></script>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Nunito:wght@300;400&family=Roboto+Slab:wght@300;400&display=swap" rel="stylesheet">
</head>
<body>
<script type="text/javascript">
window.dtocApp = new dtoc({
"ignoreNamespace": true,
"documents": "//front|//div[@type='chapter']|//div[@type='preface']|//div[@type='afterword']|//div[@type='contributors']",
"documentTitle": "head/title",
"documentAuthor": "docAuthor[1]",
"documentImages": "graphic[@url]",
"documentNotes": "note",
"documentLinks": "ref[target^='http']",
"indexDocument": "//div[@type='index']",
"inputs": [
"https://calincs.gitlab.io/access/dtoc/data/xml/sample.xml"
]
});
</script>
</body>
</html>Configuration Object Details
An explanation of the properties in the configuration object. Italicized properties are optional.
| Name | Type | Details |
|---|---|---|
| inputs | Array | An array of URLs or Files |
| documents | String | The XPath for locating the document(s) within each XML file |
| documentTitle | String | The XPath for locating the document title |
| documentAuthor | String | The XPath for locating the document author |
| documentImages | String | The XPath for identifying images |
| documentNotes | String | The XPath for identifying notes |
| documentLinks | String | The XPath for identifying links |
| ignoreNamespace | Boolean | Whether to remove the root/default namespace prior to evaluating XPaths. Use to avoid having to use local-name() in XPaths. |
| editionTitle | String | The title of the edition |
| editionSubtitle | String | The subtitle of the edition |
| indexDocument | String | The XPath for locating the index document to use as the corpus index |
| curation | Object | An optional curation object. Can be used to customize the tags panel and the table of contents panel. |
| curation.markup | Array | An array of markup |
| curation.toc | Array | The table of contents |