book-source 0.3.15 → 0.3.17

package/lib/StructuredDocument.js

@@ -28,7 +28,6 @@
 
 
 
-const documentParts = require( './documentParts.js' ) ;
 const Style = require( './Style.js' ) ;
 const textPostFilters = require( './textPostFilters.js' ) ;
 
@@ -41,7 +40,8 @@ function StructuredDocument() {
 	this.title = 'Document' ;
 	this.metadata = null ;
 	this.theme = null ;
-	this.summary = null ;
+	this.toc = null ;
+	this.tocList = null ;
 	this.parts = [] ;
 	//this.idList = new Set() ;
 }
@@ -49,6 +49,7 @@ function StructuredDocument() {
 module.exports = StructuredDocument ;
 
 // Circular require, should come after exporting
+const documentParts = require( './documentParts.js' ) ;
 const postProcesses = require( './postProcesses.js' ) ;
 
 
@@ -57,8 +58,8 @@ StructuredDocument.prototype.render = function( renderer , special = null ) {
 	let toRender ;
 
 	switch ( special ) {
-		case 'summary' :
-			toRender = this.summary ? [ this.summary ] : [] ;
+		case 'toc' :
+			toRender = this.tocList ? [ this.tocList ] : [] ;
 			break ;
 		default :
 			toRender = this.parts ;
@@ -813,8 +814,20 @@ function parseListItem( str , ctx , indent ) {
 
 	var lastPart = ctx.parts[ ctx.parts.length - 1 ] ;
 
-	if ( ! lastPart || lastPart.type !== 'list' ) {
-		ctx.parts.push( new documentParts.List( indent ) ) ;
+	switch ( lastPart?.type ) {
+		case 'listItem' :
+		case 'orderedListItem' :
+			// Create the new list as a child of this list-item
+			stack( ctx ) ;
+			ctx.parts.push( new documentParts.List( indent ) ) ;
+			break ;
+		case 'list' :
+		case 'orderedList' :	// It's mixing list and ordered list, but what can we do?
+			// Nothing to do here...
+			break ;
+		default :
+			ctx.parts.push( new documentParts.List( indent ) ) ;
+			break ;
 	}
 
 	stack( ctx ) ;
@@ -836,9 +849,22 @@ function parseOrderedListItem( str , ctx , indent ) {
 
 	var lastPart = ctx.parts[ ctx.parts.length - 1 ] ;
 
-	if ( ! lastPart || lastPart.type !== 'orderedList' ) {
-		lastPart = new documentParts.OrderedList( indent ) ;
-		ctx.parts.push( lastPart ) ;
+	switch ( lastPart?.type ) {
+		case 'orderedListItem' :
+		case 'listItem' :
+			// Create the new ordered list as a child of this list-item
+			stack( ctx ) ;
+			lastPart = new documentParts.OrderedList( indent ) ;
+			ctx.parts.push( lastPart ) ;
+			break ;
+		case 'orderedList' :
+		case 'list' :	// It's mixing list and ordered list, but what can we do?
+			// Nothing to do here...
+			break ;
+		default :
+			lastPart = new documentParts.OrderedList( indent ) ;
+			ctx.parts.push( lastPart ) ;
+			break ;
 	}
 
 	stack( ctx ) ;

package/lib/documentParts.js

@@ -31,6 +31,9 @@
 const documentParts = {} ;
 module.exports = documentParts ;
 
+// Circular require, should come after exporting
+const StructuredDocument = require( './StructuredDocument.js' ) ;
+
 
 
 function Part() {
@@ -39,6 +42,10 @@ function Part() {
 
 documentParts.Part = Part ;
 
+Part.prototype.getText = function() {
+	return StructuredDocument.getText( this ) ;
+} ;
+
 
 
 function InlinePart() {
@@ -372,7 +379,7 @@ documentParts.Anchor = Anchor ;
 
 
 // All special types that could be rendered (have graphical representation)
-const RENDERED_SPECIAL_TYPES = new Set( [ 'summary' ] ) ;
+const RENDERED_SPECIAL_TYPES = new Set( [ 'toc' ] ) ;
 
 function Special( special ) {
 	this.type = 'special' ;

package/lib/postProcesses.js

@@ -72,24 +72,25 @@ exports.autoId.init = ( structuredDocument , params , data ) => {
 
 
 
-exports.summary = ( structuredDocument , object , params , data ) => {
+// TOC: Table of Contents
+exports.toc = ( structuredDocument , object , params , data ) => {
 	if ( object.type === 'special' ) {
 		switch ( object.special ) {
-			case 'summary' :
-				data.summaryObjects.push( object ) ;
+			case 'toc' :
+				data.tocObjects.push( object ) ;
 				break ;
-			case 'summary-start' :
-				resetSummary( data ) ;
+			case 'toc-start' :
+				resetToc( data ) ;
 				break ;
-			case 'summary-end' :
-				data.summaryEnded = true ;
+			case 'toc-end' :
+				data.tocEnded = true ;
 				break ;
 		}
 
 		return ;
 	}
 
-	if ( data.summaryEnded || object.type !== 'header' || object.level > params.maxLevel ) { return ; }
+	if ( data.tocEnded || object.type !== 'header' || object.level > params.maxLevel ) { return ; }
 
 	let item = new documentParts.ListItem( object.level - 1 ) ;
 	let link = new documentParts.Link( '#' + object.id ) ;
@@ -97,54 +98,73 @@ exports.summary = ( structuredDocument , object , params , data ) => {
 	let text = new documentParts.Text( StructuredDocument.getText( object ) ) ;
 	link.parts.push( text ) ;
 
-	if ( ! data.summaryHeaderLevelStack.length ) {
-		data.summaryHeaderLevelStack.push( object.level ) ;
+	let simpleItem = { title: object.getText() , href: object.href , children: [] } ;
+
+	if ( ! data.tocHeaderLevelStack.length ) {
+		data.tocHeaderLevelStack.push( object.level ) ;
 	}
 
-	let lastListLevel = data.summaryHeaderLevelStack.length - 1 ;
-	let lastHeaderLevel = data.summaryHeaderLevelStack[ lastListLevel ] ;
+	let lastListLevel = data.tocHeaderLevelStack.length - 1 ;
+	let lastHeaderLevel = data.tocHeaderLevelStack[ lastListLevel ] ;
 
 	while ( object.level < lastHeaderLevel && lastListLevel > 0 ) {
 		lastListLevel -- ;
-		lastHeaderLevel = data.summaryHeaderLevelStack[ lastListLevel ] ;
-		data.summaryHeaderLevelStack.length = data.summaryListStack.length = lastListLevel + 1 ;
+		lastHeaderLevel = data.tocHeaderLevelStack[ lastListLevel ] ;
+		data.tocHeaderLevelStack.length = data.tocListStack.length = lastListLevel + 1 ;
 	}
 
 	if ( object.level > lastHeaderLevel ) {
-		let parentList = data.summaryListStack[ lastListLevel ] ;
+		data.tocHeaderLevelStack.push( object.level ) ;
+
+		let parentList = data.tocListStack[ lastListLevel ] ;
+		let parentListItem = parentList.parts[ parentList.parts.length - 1 ] ;
 		let currentList = new documentParts.List( object.level - 1 ) ;
-		data.summaryListStack.push( currentList ) ;
-		data.summaryHeaderLevelStack.push( object.level ) ;
 		currentList.parts.push( item ) ;
-		parentList.parts.push( currentList ) ;
+		data.tocListStack.push( currentList ) ;
+		parentListItem.parts.push( currentList ) ;
+
+		let parentSimpleList = data.tocSimpleListStack[ lastListLevel ] ;
+		let parentSimpleItem = parentSimpleList[ parentSimpleList.length - 1 ] ;
+		let currentSimpleList = parentSimpleItem.children ;
+		currentSimpleList.push( simpleItem ) ;
+		data.tocSimpleListStack.push( currentSimpleList ) ;
 	}
 	else {
 		// It's equal OR the doc is not well-formed and it's less, nevertheless, we just act as if it's equal
-		let currentList = data.summaryListStack[ lastListLevel ] ;
+		let currentList = data.tocListStack[ lastListLevel ] ;
 		currentList.parts.push( item ) ;
+
+		let currentSimpleList = data.tocSimpleListStack[ lastListLevel ] ;
+		currentSimpleList.push( simpleItem ) ;
 	}
 } ;
 
-exports.summary.init = ( structuredDocument , params , data ) => {
+exports.toc.init = ( structuredDocument , params , data ) => {
 	params.maxLevel = params.maxLevel || Infinity ;
-	data.summaryObjects = [] ;
-	resetSummary( data ) ;
+	data.tocObjects = [] ;
+	resetToc( data ) ;
 } ;
 
-function resetSummary( data ) {
-	data.summaryList = new documentParts.List( 0 ) ;
-	data.summaryListStack = [ data.summaryList ] ;
-	data.summaryHeaderLevelStack = [] ;
-	data.summaryEnded = false ;
+function resetToc( data ) {
+	data.tocList = new documentParts.List( 0 ) ;
+	data.tocListStack = [ data.tocList ] ;
+
+	// Variant easier to manage for custom userland
+	data.tocSimpleList = [] ;
+	data.tocSimpleListStack = [ data.tocSimpleList ] ;
+
+	data.tocHeaderLevelStack = [] ;
+	data.tocEnded = false ;
 }
 
-exports.summary.finalize = ( structuredDocument , params , data ) => {
-	structuredDocument.summary = data.summaryList ;
+exports.toc.finalize = ( structuredDocument , params , data ) => {
+	structuredDocument.tocList = data.tocList ;
+	structuredDocument.toc = data.tocSimpleList ;
 
-	for ( let summaryObject of data.summaryObjects ) {
-		summaryObject.parts.push( data.summaryList ) ;
+	for ( let tocObject of data.tocObjects ) {
+		tocObject.parts.push( data.tocList ) ;
 	}
 } ;
 
-exports.summary.require = [ 'autoId' ] ;
+exports.toc.require = [ 'autoId' ] ;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "book-source",
-  "version": "0.3.15",
+  "version": "0.3.17",
   "description": "A lightweight markup language, inspired by Markdown.",
   "main": "lib/book-source.js",
   "directories": {