npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cwrc/dtoc

v0.3.16

Published

Standalone version of DToC

Downloads

53

Readme

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.

Current build

Installation

  1. Get the files
    • Either add as a dependency: npm i @cwrc/dtoc
    • Or download: https://registry.npmjs.org/@cwrc/dtoc/-/dtoc-0.x.x.tgz
  2. Copy files to a directory in your workspace
  3. 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">
		const dtocApp = new dtoc();
	</script>
	</body>
</html>

Loading Documents

There are two approaches for loading documents into DToC.

Constructor With Input Configuration

Provide a configuration object with an input entry to the constructor.

new dtoc({
	"dtocRootUrl": "https://calincs.gitlab.io/cwrc/dtoc/",
	"input": {
		"documents": "//div[@type='chapter']|//div[@type='preface']|//div[@type='afterword']",
		...
		"inputs": [
			"https://calincs.gitlab.io/cwrc/dtoc/dtoc-2.0/data/xml/sample.xml"
		]
	}
});

Calling Methods After Initialization

Call load with an input configuration.

const dtocApp = new dtoc();
dtocApp.load({
	"documents": "//div[@type='chapter']|//div[@type='preface']|//div[@type='afterword']",
	...
	"inputs": [
		"https://calincs.gitlab.io/cwrc/dtoc/dtoc-2.0/data/xml/sample.xml"
	]
})

Call showInputWindow (with an optional input configuration).

const dtocApp = new dtoc();
dtocApp.showInputWindow();

Configuration Object Details

The configuration object contains app configuration as well as the input configuration.

Italicized properties are optional

Configuration Object

| Name | Type | Details | | ---- | ---- | ------- | | dtocRootUrl | String | An URL specifying the location of the DToC files root. If not provided then window.location will be used. | | input | Object | The input configuration object (see below for details) | | showMenu | Boolean | Whether to show the options menu. Default is true. | | showTitle | Boolean | Whether to show the edition title. Default is true. | | debug | Boolean | Whether to enable debug messages in the console. |

Input Configuration Object

| Name | Type | Details | | ---- | ---- | ------- | | inputs | Array | An array of URLs or Files | | documents | String | The XPath for locating the document(s) within each XML file | | documentContent | String | The XPath for locating the actual content within the document | | 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 |

Get the Input Configuration Object

You can get the current input configuration by calling the getInputConfig method.

const inputConfig = dtocApp.getInputConfig();
console.log(inputConfig.documents);