book-source 0.3.7 → 0.3.9

package/brainstorming

@@ -40,7 +40,9 @@
    (where style can be a color like red, green, black, or other style like bold, italic, oblique, separated by comma ",")
    (generate a <span>)
 
-✅ Title tooltip: [text][title text]
+✅ Hint (title-style tooltip): [text][title text]
+✅ Infotip (hover block-display tooltip): ?[text][some block of text]
+✅ Infotip href-variant: ?[text](href)
 
 ✅ Link: [link text](href)
 ✅ Link+Title: [link text][title text](href)

package/lib/StructuredDocument.js

@@ -199,23 +199,26 @@ StructuredDocument.prototype.autoTitle = function() {
 
 	if ( ! header ) { return ; }
 
-	str = this.getText( header.parts ) ;
+	str = StructuredDocument.getText( header.parts ) ;
 	if ( str ) { this.title = str ; }
 } ;
 
 
 
-StructuredDocument.prototype.getText = function( parts = this.parts ) {
+StructuredDocument.getText = function( parts ) {
 	var str = '' ;
 
 	for ( let part of parts ) {
 		if ( part.text ) { str += part.text ; }
-		else if ( part.parts?.length ) { str += this.getText( part.parts ) ; }
+		else if ( part.parts?.length ) { str += StructuredDocument.getText( part.parts ) ; }
 	}
 
 	return str ;
 } ;
 
+// Backqard compatibility/API
+StructuredDocument.prototype.getText = function( parts = this.parts ) { return StructuredDocument.getText( parts ) ; } ;
+
 
 
 StructuredDocument.prototype.textPostFilter = function( postFilterList , parts = this.parts ) {
@@ -747,41 +750,26 @@ function parseMedia( str , ctx , float = null ) {
 
 	ctx.i = end ;
 	ctx.iStartOfInlineChunk = ctx.i + 1 ;
+
 	var data = parseDataMark( str , ctx , MEDIA_DATA_MARK ) ;
 	if ( ! data ) { return ; }
 
 	if ( ! data.href?.[ 0 ] ) { return ; }
 
-	var type = 'imageBlock' ;
-
-	if ( data.href[ 1 ] ) {
-		switch ( data.href[ 1 ] ) {
-			case 'image' :
-				type = 'imageBlock' ;
-				break ;
-			case 'audio' :
-				type = 'audioBlock' ;
-				break ;
-			case 'video' :
-				type = 'videoBlock' ;
-				break ;
-			default :
-				return ;
-		}
-	}
-
-	var params = { type , altText: text , href: data.href[ 0 ] } ;
-
-	if ( float ) { params.float = float ; }
-
-	if ( data.text?.length ) {
-		params.caption = data.text[ 0 ] ;
-		if ( data.text[ 1 ] ) { params.title = data.text[ 1 ] ; }
+	switch ( data.href[ 1 ] || 'image' ) {
+		case 'image' :
+			ctx.parts.push( new documentParts.ImageBlock( data.href[ 0 ] , text , float , data.text?.[ 0 ] , data.text?.[ 1 ] ) ) ;
+			break ;
+		case 'audio' :
+			ctx.parts.push( new documentParts.AudioBlock( data.href[ 0 ] , text , float , data.text?.[ 0 ] , data.text?.[ 1 ] ) ) ;
+			break ;
+		case 'video' :
+			ctx.parts.push( new documentParts.VideoBlock( data.href[ 0 ] , text , float , data.text?.[ 0 ] , data.text?.[ 1 ] ) ) ;
+			break ;
+		default :
+			break ;
 	}
 
-	//if ( data.extra?.length ) { params.title = data.extra[ 0 ] ; }
-
-	ctx.parts.push( params ) ;
 	ctx.i ++ ;
 }
 
@@ -1437,6 +1425,10 @@ function parseNestedInline( str , ctx , scanEnd , topLevel = false ) {
 			addInlineTextChunk( str , ctx ) ;
 			parseStyledText( str , ctx , scanEnd ) ;
 		}
+		else if ( char === '?' && str[ ctx.i + 1 ] === '[' && lastWasSpace ) {
+			addInlineTextChunk( str , ctx ) ;
+			parseInfotipedText( str , ctx , scanEnd ) ;
+		}
 		else if ( char === '!' && str[ ctx.i + 1 ] === '[' && lastWasSpace ) {
 			addInlineTextChunk( str , ctx ) ;
 			parseImage( str , ctx , scanEnd ) ;
@@ -1596,8 +1588,6 @@ function parseStyledText( str , ctx , scanEnd ) {
 	var end = searchCloser( str , ctx.i + 1 , '[' , ']' , false , scanEnd ) ;
 	if ( end < 0 ) { return ; }
 
-	//var text = str.slice( ctx.i + 1 , end ) ;
-
 	var start = ctx.i + 1 ;
 	ctx.i = end ;
 	var data = parseDataMark( str , ctx , STYLE_DATA_MARK , scanEnd ) ;
@@ -1607,13 +1597,13 @@ function parseStyledText( str , ctx , scanEnd ) {
 
 	var href = data.href?.[ 0 ] ,
 		style = data.style?.[ 0 ] ,
-		title = data.text?.[ 0 ] ;
+		hint = data.text?.[ 0 ] ;
 
 	if ( href ) {
-		ctx.parts.push( new documentParts.Link( href , style , title ) ) ;
+		ctx.parts.push( new documentParts.Link( href , style , hint ) ) ;
 	}
-	else if ( style || title ) {
-		ctx.parts.push( new documentParts.StyledText( style , title ) ) ;
+	else if ( style || hint ) {
+		ctx.parts.push( new documentParts.StyledText( style , hint ) ) ;
 	}
 	else {
 		return ;
@@ -1628,6 +1618,41 @@ function parseStyledText( str , ctx , scanEnd ) {
 
 
 
+const INFOTIP_DATA_MARK = {
+	text: true , href: true , style: true , extra: false
+} ;
+
+function parseInfotipedText( str , ctx , scanEnd ) {
+	//console.error( "parseStyledText()" ) ;
+	var end = searchCloser( str , ctx.i + 2 , '[' , ']' , false , scanEnd ) ;
+	if ( end < 0 ) { return ; }
+
+	var start = ctx.i + 2 ;
+	ctx.i = end ;
+	var data = parseDataMark( str , ctx , INFOTIP_DATA_MARK , scanEnd ) ;
+
+	var fullMarkupEnd = ctx.i ;
+
+	var href = data?.href?.[ 0 ] ,
+		style = data?.style?.[ 0 ] ,
+		hint = data?.text?.[ 0 ] ;
+
+	var infotipedText = new documentParts.InfotipedText( hint , href , style ) ;
+	ctx.parts.push( infotipedText ) ;
+
+	ctx.i = start ;
+	parseNestedInline( str , ctx , end ) ;
+
+	ctx.i = fullMarkupEnd ;
+	ctx.iStartOfInlineChunk = ctx.i + 1 ;
+
+	if ( ! href && ! hint ) {
+		infotipedText.href = StructuredDocument.getText( infotipedText.parts ) ;
+	}
+}
+
+
+
 const IMAGE_DATA_MARK = {
 	text: true , href: true , style: false , extra: false
 } ;

package/lib/documentParts.js

@@ -67,9 +67,7 @@ documentParts.InlineTextPart = InlineTextPart ;
 
 
 
-function BlockPart() {
-	this.parts = [] ;
-}
+function BlockPart() {}
 
 BlockPart.prototype = Object.create( Part.prototype ) ;
 BlockPart.prototype.constructor = BlockPart ;
@@ -77,6 +75,16 @@ documentParts.BlockPart = BlockPart ;
 
 
 
+function BlockContainerPart() {
+	this.parts = [] ;
+}
+
+BlockContainerPart.prototype = Object.create( Part.prototype ) ;
+BlockContainerPart.prototype.constructor = BlockContainerPart ;
+documentParts.BlockContainerPart = BlockContainerPart ;
+
+
+
 // Inline Parts
 
 function Text( text ) {
@@ -126,12 +134,12 @@ documentParts.Code = Code ;
 
 
 
-function Link( href , style , title ) {
+function Link( href , style , hint ) {
 	this.type = 'link' ;
 	this.href = href ;
 	this.style = style || undefined ;
 	InlineContainerPart.call( this ) ;
-	this.title = title || undefined ;
+	this.hint = hint || undefined ;
 }
 
 Link.prototype = Object.create( InlineContainerPart.prototype ) ;
@@ -140,11 +148,26 @@ documentParts.Link = Link ;
 
 
 
-function StyledText( style , title ) {
+// Tooltip/Infotip/Hint displayed when hovering
+function InfotipedText( hint , href , style ) {
+	this.type = 'infotipedText' ;
+	this.hint = hint || undefined ;
+	this.href = href || undefined ;
+	this.style = style || undefined ;
+	InlineContainerPart.call( this ) ;
+}
+
+InfotipedText.prototype = Object.create( InlineContainerPart.prototype ) ;
+InfotipedText.prototype.constructor = InfotipedText ;
+documentParts.InfotipedText = InfotipedText ;
+
+
+
+function StyledText( style , hint ) {
 	this.type = 'styledText' ;
 	this.style = style || undefined ;
 	InlineContainerPart.call( this ) ;
-	this.title = title || undefined ;
+	this.hint = hint || undefined ;
 }
 
 StyledText.prototype = Object.create( InlineContainerPart.prototype ) ;
@@ -153,11 +176,11 @@ documentParts.StyledText = StyledText ;
 
 
 
-function Image( href , altText , title ) {
+function Image( href , altText , hint ) {
 	this.type = 'image' ;
 	this.href = href ;
 	this.altText = altText ;
-	this.title = title || undefined ;
+	this.hint = hint || undefined ;
 	InlinePart.call( this ) ;
 }
 
@@ -169,7 +192,7 @@ documentParts.Image = Image ;
 
 const emoji = require( 'string-kit/lib/emoji.js' ) ;
 
-function Pictogram( code , altText , title ) {
+function Pictogram( code , altText , hint ) {
 	this.type = 'pictogram' ;
 	this.code = code ;
 
@@ -181,7 +204,7 @@ function Pictogram( code , altText , title ) {
 		emojiChar ? emoji.getCanonicalName( emojiChar ) :
 		undefined ;
 
-	this.title = title || undefined ;
+	this.hint = hint || undefined ;
 
 	InlinePart.call( this ) ;
 }
@@ -196,10 +219,10 @@ documentParts.Pictogram = Pictogram ;
 
 function Paragraph() {
 	this.type = 'paragraph' ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Paragraph.prototype = Object.create( BlockPart.prototype ) ;
+Paragraph.prototype = Object.create( BlockContainerPart.prototype ) ;
 Paragraph.prototype.constructor = Paragraph ;
 documentParts.Paragraph = Paragraph ;
 
@@ -208,10 +231,10 @@ documentParts.Paragraph = Paragraph ;
 function Header( level ) {
 	this.type = 'header' ;
 	this.level = level ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Header.prototype = Object.create( BlockPart.prototype ) ;
+Header.prototype = Object.create( BlockContainerPart.prototype ) ;
 Header.prototype.constructor = Header ;
 documentParts.Header = Header ;
 
@@ -219,10 +242,10 @@ documentParts.Header = Header ;
 
 function Cite() {
 	this.type = 'cite' ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Cite.prototype = Object.create( BlockPart.prototype ) ;
+Cite.prototype = Object.create( BlockContainerPart.prototype ) ;
 Cite.prototype.constructor = Cite ;
 documentParts.Cite = Cite ;
 
@@ -231,10 +254,10 @@ documentParts.Cite = Cite ;
 function List( indent ) {
 	this.type = 'list' ;
 	this.indent = indent ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-List.prototype = Object.create( BlockPart.prototype ) ;
+List.prototype = Object.create( BlockContainerPart.prototype ) ;
 List.prototype.constructor = List ;
 documentParts.List = List ;
 
@@ -243,10 +266,10 @@ documentParts.List = List ;
 function ListItem( indent ) {
 	this.type = 'listItem' ;
 	this.indent = indent ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-ListItem.prototype = Object.create( BlockPart.prototype ) ;
+ListItem.prototype = Object.create( BlockContainerPart.prototype ) ;
 ListItem.prototype.constructor = ListItem ;
 documentParts.ListItem = ListItem ;
 
@@ -256,10 +279,10 @@ function OrderedList( indent ) {
 	this.type = 'orderedList' ;
 	this.indent = indent ;
 	this.autoIndex = 1 ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-OrderedList.prototype = Object.create( BlockPart.prototype ) ;
+OrderedList.prototype = Object.create( BlockContainerPart.prototype ) ;
 OrderedList.prototype.constructor = OrderedList ;
 documentParts.OrderedList = OrderedList ;
 
@@ -270,10 +293,10 @@ function OrderedListItem( indent , order , index ) {
 	this.indent = indent ;
 	this.order = order ;	// User order value
 	this.index = index ;	// Real index, starting at 1, and auto-incrementing
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-OrderedListItem.prototype = Object.create( BlockPart.prototype ) ;
+OrderedListItem.prototype = Object.create( BlockContainerPart.prototype ) ;
 OrderedListItem.prototype.constructor = OrderedListItem ;
 documentParts.OrderedListItem = OrderedListItem ;
 
@@ -282,10 +305,10 @@ documentParts.OrderedListItem = OrderedListItem ;
 function Quote( indent ) {
 	this.type = 'quote' ;
 	this.indent = indent ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Quote.prototype = Object.create( BlockPart.prototype ) ;
+Quote.prototype = Object.create( BlockContainerPart.prototype ) ;
 Quote.prototype.constructor = Quote ;
 documentParts.Quote = Quote ;
 
@@ -294,10 +317,10 @@ documentParts.Quote = Quote ;
 function HorizontalRule( clearFloat ) {
 	this.type = 'horizontalRule' ;
 	this.clearFloat = clearFloat ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-HorizontalRule.prototype = Object.create( BlockPart.prototype ) ;
+HorizontalRule.prototype = Object.create( BlockContainerPart.prototype ) ;
 HorizontalRule.prototype.constructor = HorizontalRule ;
 documentParts.HorizontalRule = HorizontalRule ;
 
@@ -305,10 +328,10 @@ documentParts.HorizontalRule = HorizontalRule ;
 
 function ClearFloat() {
 	this.type = 'clearFloat' ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-ClearFloat.prototype = Object.create( BlockPart.prototype ) ;
+ClearFloat.prototype = Object.create( BlockContainerPart.prototype ) ;
 ClearFloat.prototype.constructor = ClearFloat ;
 documentParts.ClearFloat = ClearFloat ;
 
@@ -318,10 +341,10 @@ function CodeBlock( text , lang ) {
 	this.type = 'codeBlock' ;
 	this.lang = lang || undefined ;
 	this.text = text ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-CodeBlock.prototype = Object.create( BlockPart.prototype ) ;
+CodeBlock.prototype = Object.create( BlockContainerPart.prototype ) ;
 CodeBlock.prototype.constructor = CodeBlock ;
 documentParts.CodeBlock = CodeBlock ;
 
@@ -330,15 +353,63 @@ documentParts.CodeBlock = CodeBlock ;
 function Anchor( href ) {
 	this.type = 'anchor' ;
 	this.href = href ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Anchor.prototype = Object.create( BlockPart.prototype ) ;
+Anchor.prototype = Object.create( BlockContainerPart.prototype ) ;
 Anchor.prototype.constructor = Anchor ;
 documentParts.Anchor = Anchor ;
 
 
 
+function ImageBlock( href , altText , float , caption , hint ) {
+	this.type = 'imageBlock' ;
+	this.href = href ;
+	this.altText = altText ;
+	this.float = float || undefined ;
+	this.caption = caption || undefined ;
+	this.hint = hint || undefined ;
+	BlockPart.call( this ) ;
+}
+
+ImageBlock.prototype = Object.create( BlockPart.prototype ) ;
+ImageBlock.prototype.constructor = ImageBlock ;
+documentParts.ImageBlock = ImageBlock ;
+
+
+
+function AudioBlock( href , altText , float , caption , hint ) {
+	this.type = 'audioBlock' ;
+	this.href = href ;
+	this.altText = altText ;
+	this.float = float || undefined ;
+	this.caption = caption || undefined ;
+	this.hint = hint || undefined ;
+	BlockPart.call( this ) ;
+}
+
+AudioBlock.prototype = Object.create( BlockPart.prototype ) ;
+AudioBlock.prototype.constructor = AudioBlock ;
+documentParts.AudioBlock = AudioBlock ;
+
+
+
+function VideoBlock( href , altText , float , caption , hint ) {
+	this.type = 'videoBlock' ;
+	this.href = href ;
+	this.altText = altText ;
+	this.float = float || undefined ;
+	this.caption = caption || undefined ;
+	this.hint = hint || undefined ;
+	BlockPart.call( this ) ;
+}
+
+VideoBlock.prototype = Object.create( BlockPart.prototype ) ;
+VideoBlock.prototype.constructor = VideoBlock ;
+documentParts.VideoBlock = VideoBlock ;
+
+
+
 function Table() {
 	this.type = 'table' ;
 	this.columns = [] ;
@@ -346,10 +417,10 @@ function Table() {
 	this.hasHeadSeparator = false ;
 	this.hasRowSeparator = false ;
 	this.hasRowSpan = false ;	// Useful to disable background colors based on odd/even rows
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-Table.prototype = Object.create( BlockPart.prototype ) ;
+Table.prototype = Object.create( BlockContainerPart.prototype ) ;
 Table.prototype.constructor = Table ;
 documentParts.Table = Table ;
 
@@ -358,10 +429,10 @@ documentParts.Table = Table ;
 function TableCaption( style ) {
 	this.type = 'tableCaption' ;
 	this.style = style || undefined ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-TableCaption.prototype = Object.create( BlockPart.prototype ) ;
+TableCaption.prototype = Object.create( BlockContainerPart.prototype ) ;
 TableCaption.prototype.constructor = TableCaption ;
 documentParts.TableCaption = TableCaption ;
 
@@ -372,10 +443,10 @@ function TableRow( style ) {
 	this.style = style || undefined ;
 	this.rowSeparator = false ;
 	this.continueRowSpan = undefined ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-TableRow.prototype = Object.create( BlockPart.prototype ) ;
+TableRow.prototype = Object.create( BlockContainerPart.prototype ) ;
 TableRow.prototype.constructor = TableRow ;
 documentParts.TableRow = TableRow ;
 
@@ -394,10 +465,10 @@ function TableHeadRow( style ) {
 	this.style = style || undefined ;
 	this.rowSeparator = false ;
 	this.continueRowSpan = undefined ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-TableHeadRow.prototype = Object.create( BlockPart.prototype ) ;
+TableHeadRow.prototype = Object.create( BlockContainerPart.prototype ) ;
 TableHeadRow.prototype.constructor = TableHeadRow ;
 documentParts.TableHeadRow = TableHeadRow ;
 
@@ -413,10 +484,10 @@ function TableCell( style ) {
 	this.sx = - 1 ;
 	this.ex = - 1 ;
 	this.masterCell = undefined ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-TableCell.prototype = Object.create( BlockPart.prototype ) ;
+TableCell.prototype = Object.create( BlockContainerPart.prototype ) ;
 TableCell.prototype.constructor = TableCell ;
 documentParts.TableCell = TableCell ;
 
@@ -447,10 +518,10 @@ function TableHeadCell( style ) {
 	this.masterCell = undefined ;
 	this.isColumnHead = false ;
 	this.isRowHead = false ;
-	BlockPart.call( this ) ;
+	BlockContainerPart.call( this ) ;
 }
 
-TableHeadCell.prototype = Object.create( BlockPart.prototype ) ;
+TableHeadCell.prototype = Object.create( BlockContainerPart.prototype ) ;
 TableHeadCell.prototype.constructor = TableHeadCell ;
 documentParts.TableHeadCell = TableHeadCell ;
 

package/package.json

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