Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

abstract-numbering

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

abstract-numbering

JSON schema for abstract numberings of hierarchical document parts

  • 3.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

abstract-numbering

JSON schema for abstract numberings of hierarchical document parts

Abstract numberings express how hierarchical document parts like outline sections, headings, or list items should be numbered, without rendering those numberings in any particular way. Other modules in the *-numbering family convert abstract numberings to strings in particular styles, like "1.2" or "1(a)(v)".

Each abstract numbering is an array of numbering components, describing first the top-most "parent" of the relevant document part and continuing down to the document part to be numbered itself.

Here is an example of a numbering for the first of two elements at the very top level of a document:

var schema = require('abstract-numbering')
var ajv = new (require('ajv'))()
var assert = require('assert')

assert(
  ajv.validate(
    schema,
    [
      {
        // More on series later.
        series: { number: 1, of: 1 },
        // "Element number 1 of 2"
        element: { number: 1, of: 2 }
      }
    ]
  )
)

Note that positions begin with one, not zero:

assert(
  !ajv.validate(
    schema,
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 0, of: 1 }
      }
    ]
  )
)

Series are used to describe situations when numbering restarts in the middle of a document part. Consider the following structure:

Heading 1. First Major Heading

  1. Apples
  2. Oranges
  3. Grapes

  1. Lions
  2. Tigers
  3. Bears

Heading 2. Second Major Heading

The abstract numbering for the "Tigers" list item would be:

assert(
  ajv.validate(
    schema,
    [
      // The component for "First Major Heading"
      {
        // Numbering of headings does not restart, so there is one series.
        series: { number: 1, of: 1 },
        element: { number: 1, of: 2 }
      },
      // The component for "Tigers"
      {
        // There are two series here, the first for fruit and animals.
        // "Tigers" is in the second series.
        series: { number: 2, of: 2 },
        // There are three total elements, of which "Tigers" is second.
        element: { number: 2, of: 3 }
      }
    ]
  )
)

Keywords

FAQs

Package last updated on 29 May 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc