@antora/assembler 1.0.0-rc.8 → 1.0.0-rc.9

package/lib/compile-conversion-attributes.js

@@ -16,12 +16,13 @@ async function compileConversionAttributes (doc, targetExtname, assemblerConfig,
   const outdir = ospath.dirname(docfile)
   const outfile = docfile.substring(0, docfile.length - docfilesuffix.length) + targetExtname
   const docdir = relativeToOutput ? dir : outdir
-  const imagesoutdir = ospath.join(outdir, '..', '_images')
+  //const imagesoutdir = ospath.join(outdir, '..', '_images/generated')
+  const imagesoutdir = outdir
   const attributes = Object.assign({ revdate: `${assemblerConfig.assembly.revdate}@` }, docAttributes, {
     docdir,
     docfile,
     docfilesuffix,
-    docname: `${docname}@`,
+    docname,
     imagesdir: '',
     imagesoutdir,
     outdir,

package/lib/constants.js

@@ -9,6 +9,7 @@ module.exports = Object.freeze({
     'insertStartPage',
     'profile',
     'rootLevel',
+    'rootPageStyle',
     'sectionMergeStrategy',
     'xmlIds',
   ],

package/lib/produce-assembly-file.js

@@ -52,7 +52,7 @@ function produceAssemblyFile (
       src: { component, version, module: 'ROOT', family: 'page', relative: '_.adoc', path: '_.adoc' },
     },
     undefined,
-    asciidocConfig
+    Object.assign({}, asciidocConfig, { antoraResourceRefs: false, extensions: [] })
   )
   const idSeparators = {
     prefix:
@@ -223,7 +223,8 @@ function mergeAsciiDoc (
   let navtitle = outlineEntry.navtitle ?? (page && hash ? page.asciidoc.navtitle : outlineEntry.content)
   let navtitlePlain = sanitize(navtitle)
   let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
-  const { filetype, linkReferenceStyle, pubRoot, sectionMergeStrategy, siteRoot, logger, rootLevel } = assemblyModel
+  const { filetype, linkReferenceStyle, pubRoot, siteRoot, logger, rootLevel, rootPageStyle } = assemblyModel
+  let sectionMergeStrategy = assemblyModel.sectionMergeStrategy
   const doctype = assemblyModel.doctype
   const atDocumentRoot = !builder.body?.length
   let atBookRoot = atDocumentRoot && !level && doctype === 'book' && (supportsParts = true)
@@ -238,16 +239,9 @@ function mergeAsciiDoc (
       Object.assign({}, page, { contents: Buffer.from(contents.toString().trimEnd()), mediaType: page.src.mediaType })
     )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
+    if (typeof doc.applyLogger === 'function') doc.applyLogger()
+    if (logger) doc.getLogger().delegate = logger
     doc.catalog.syntheticIds = {}
-    doc.logger = logger
-      ? Object.assign(doc.getLogger().$dup(), {
-          delegate: {
-            warn () {
-              return logger.warn.apply(logger, arguments)
-            },
-          },
-        })
-      : doc.getLogger()
     doc.source_header_attributes ??= toHash()
     const isRootPage = atDocumentRoot && !level
     const { component, version, module: module_, relative, origin } = page.src
@@ -270,6 +264,7 @@ function mergeAsciiDoc (
         }
       }
     }
+    const overviewTitle = doc.getAttribute('overview-title', 'Overview')
     // NOTE: in Antora, docname is relative src path from module without file extension
     const docname = doc.getAttribute('docname')
     const pageId = generateScopedId(page.src, componentVersion, idSeparators, filetype)
@@ -277,8 +272,8 @@ function mergeAsciiDoc (
     let pageFragment = `#${pageId}`
     let pageRoles = []
     let pageStyle = doc.getAttribute('assembly-style', '')
-    if (!pageStyle && atBookRoot && rootLevel === 0 && !doc.source_header_attributes['$key?']('assembly-style')) {
-      pageStyle = 'preface'
+    if (!pageStyle && isRootPage && !doc.source_header_attributes['$key?']('assembly-style')) {
+      pageStyle = rootPageStyle || ''
     }
     let part
     if ((part = pageStyle === 'part')) {
@@ -289,40 +284,22 @@ function mergeAsciiDoc (
       if (!supportsParts) part = undefined
     }
     const hasSections = doc.hasSections()
+    const encloseSections = sectionMergeStrategy === 'enclose' && hasItems && hasSections
     let nextSectionLevel = 1
     const lines = doc.getSourceLines()
     const ignoreLines = []
     const buffer = (builder.body ??= [])
     if (buffer.length) buffer.push('')
-    buffer.push(`:docname: ${docname}`)
-    if (component !== builder.currentComponentVersion.name) {
-      const thisComponentVersion =
-        component === componentVersion.name && version === componentVersion.version
-          ? componentVersion
-          : contentCatalog.getComponentVersion(component, version)
-      if (thisComponentVersion) {
-        buffer.push(`:page-component-name: ${thisComponentVersion.name}`)
-        buffer.push(`:page-component-version:${thisComponentVersion.version ? ' ' + thisComponentVersion.version : ''}`)
-        buffer.push(':page-version: {page-component-version}')
-        buffer.push(`:page-component-display-version: ${thisComponentVersion.displayVersion}`)
-        buffer.push(`:page-component-title: ${thisComponentVersion.title}`)
-        builder.currentComponentVersion = thisComponentVersion
-      }
-    }
-    buffer.push(`:page-module: ${module_}`)
-    buffer.push(`:page-relative-src-path: ${relative}`)
-    buffer.push(`:page-origin-url: ${origin.url}`)
-    buffer.push(`:page-origin-start-path:${origin.startPath && ' '}${origin.startPath}`)
-    buffer.push(`:page-origin-refname: ${origin.branch || origin.tag}`)
-    buffer.push(`:page-origin-reftype: ${origin.branch ? 'branch' : 'tag'}`)
-    buffer.push(`:page-origin-refhash: ${origin.worktree ? '(worktree)' : origin.refhash}`)
     if (doc.hasHeader()) {
       for (const entry of processDocumentHeader(doc, lines, ignoreLines, isRootPage)) {
         if (entry.type === 'author_line') {
           builder.setAuthor(entry.lines[0])
         } else if (entry.type === 'attribute_entry') {
           const name = entry.name
-          if (!entry.negated && !doc.isAttributeLocked(name)) {
+          if (entry.negated && name === 'sectnums') {
+            // catch sectnums missed by reducer; only allow turned off, not turning on
+            doc.source_header_attributes['$[]=']('sectnums', null)
+          } else if (!entry.negated && !doc.isAttributeLocked(name)) {
             let val, newVal
             if (
               name.endsWith('-image') &&
@@ -369,46 +346,81 @@ function mergeAsciiDoc (
       pageRoles = doc.getRoles()
     }
     if (roles.length) pageRoles = pageRoles.concat(roles[0] === 'page' ? roles.slice(1) : roles)
+    buffer.push(`:page-docname: ${docname}`)
+    if (component !== builder.currentComponentVersion.name) {
+      const thisComponentVersion =
+        component === componentVersion.name && version === componentVersion.version
+          ? componentVersion
+          : contentCatalog.getComponentVersion(component, version)
+      if (thisComponentVersion) {
+        buffer.push(`:page-component-name: ${thisComponentVersion.name}`)
+        buffer.push(`:page-component-version:${thisComponentVersion.version ? ' ' + thisComponentVersion.version : ''}`)
+        buffer.push(':page-version: {page-component-version}')
+        buffer.push(`:page-component-display-version: ${thisComponentVersion.displayVersion}`)
+        buffer.push(`:page-component-title: ${thisComponentVersion.title}`)
+        builder.currentComponentVersion = thisComponentVersion
+      }
+    }
+    buffer.push(`:page-module: ${module_}`)
+    buffer.push(`:page-relative-src-path: ${relative}`)
+    buffer.push(`:page-origin-url: ${origin.url}`)
+    buffer.push(`:page-origin-start-path:${origin.startPath && ' '}${origin.startPath}`)
+    buffer.push(`:page-origin-refname: ${origin.branch || origin.tag}`)
+    buffer.push(`:page-origin-reftype: ${origin.branch ? 'branch' : 'tag'}`)
+    buffer.push(`:page-origin-refhash: ${origin.worktree ? '(worktree)' : origin.refhash}`)
     let heading
     if (pageStyle && (part && level === 1 ? (level = 0) : level) === 0) {
       let htitleAsciiDoc = navtitleAsciiDoc
-      let notitle
       if (pageStyle === 'preface') {
         const hasPrefaceTitleAttr =
           doc.isAttribute('preface-title') ||
           doc.source_header_attributes['$key?']('preface-title') ||
           doc.isAttributeLocked('preface-title')
-        const htitleOverride = hasPrefaceTitleAttr
-          ? doc.getAttribute('preface-title', '')
-          : atDocumentRoot && (rootLevel ? true : !hasAssemblyNavtitleAttr)
-            ? ''
-            : undefined
+        let htitleOverride
+        if (hasPrefaceTitleAttr) {
+          htitleOverride = doc.getAttribute('preface-title', '')
+        } else if (encloseSections && !hasAssemblyNavtitleAttr) {
+          htitleOverride = overviewTitle
+        } else if (atDocumentRoot && (rootLevel ? true : !hasAssemblyNavtitleAttr)) {
+          htitleOverride = ''
+        }
+        const usePrefaceTitleAttr = hasPrefaceTitleAttr && atBookRoot
         if (htitleOverride != null) {
-          const keepSections = hasSections && sectionMergeStrategy !== 'discrete'
+          const hasSectionsInAssembly = hasSections && sectionMergeStrategy !== 'discrete'
           if (htitleOverride === '') {
-            if (builder.headerHasBlockAttrs || keepSections) {
+            nextSectionLevel = 2
+            sectionMergeStrategy = 'discrete'
+            if (builder.headerHasBlockAttrs) {
               htitleAsciiDoc = '{empty}'
-              notitle = true
             } else {
-              if (hasPrefaceTitleAttr) builder.header.push(':preface-title:')
+              if (usePrefaceTitleAttr) builder.header.push(':preface-title:')
               htitleAsciiDoc = undefined
             }
-          } else if (hasPrefaceTitleAttr && !builder.headerHasBlockAttrs && !keepSections) {
+          } else if (usePrefaceTitleAttr && !(builder.headerHasBlockAttrs || hasSectionsInAssembly)) {
             builder.header.push(`:preface-title: ${unconvertInlineAsciiDoc(htitleOverride)}`)
             htitleAsciiDoc = undefined
           } else {
             htitleAsciiDoc = unconvertInlineAsciiDoc(htitleOverride)
           }
         }
+      } else if (encloseSections && atDocumentRoot && !hasAssemblyNavtitleAttr) {
+        htitleAsciiDoc = unconvertInlineAsciiDoc(overviewTitle)
       }
       if (htitleAsciiDoc) {
         if (atDocumentRoot) {
           // Q: should we use htitleAsciiDoc to generate ID if not {empty} instead of pageStyle
           pageFragment = `#_${idSeparators.coordinate}${pageIdLeader}${pageStyle}`
           builder.setDocid(pageId)
+          if (pageStyle === 'preface' && !atBookRoot) {
+            if (doc.hasAttribute('sectnums')) {
+              doc.source_header_attributes['$[]=']('sectnums', null)
+              buffer.push(':!sectnums:')
+            }
+            pageStyle = ''
+          }
         }
         heading = { title: htitleAsciiDoc, level: part ? 1 : 2 }
-        if (notitle) heading.notitle = true
+        if (htitleAsciiDoc === '{empty}') heading.notitle = true
         nextSectionLevel = 2 // next section level is 2, even for special part
       }
     } else if (level) {
@@ -435,11 +447,7 @@ function mergeAsciiDoc (
     }
     if (isRootPage || (atDocumentRoot && !heading)) assembled.pages.rootPageFragment = pageFragment
     assembled.pages.set(page, pageFragment)
-    if (sectionMergeStrategy === 'enclose' && hasItems && hasSections && !(atDocumentRoot && heading)) {
-      // TODO: make overview section title configurable
-      //let overviewTitle = doc.getDocumentTitle()
-      //if (overviewTitle === navtitle) overviewTitle = doc.getAttribute('overview-title', 'Overview')
-      const overviewTitle = doc.getAttribute('overview-title', 'Overview')
+    if (encloseSections && !(atDocumentRoot && heading)) {
       const syntheticId = idSeparators.generateIdFromTitle(overviewTitle, idSeparators, pageIdLeader)
       if (heading && buffer.length) buffer.push('')
       let hlevel = level + (nextSectionLevel = 2)
@@ -645,6 +653,7 @@ function mergeAsciiDoc (
       )
       if (resolvedAttributeEntries.length > 1) safePush(buffer, resolvedAttributeEntries)
     }
+    if (typeof doc.restoreLogger === 'function') doc.restoreLogger()
   } else if (level && !hash) {
     const buffer = (builder.body ??= [])
     if (atDocumentRoot && rootLevel === 0 && navtitlePlain === componentVersion.title) {
@@ -721,8 +730,7 @@ function processDocumentHeader (doc, lines, ignoreLines, isRootPage) {
       }
       assemblyHeaderAttributes.delete('%authors')
     }
-    const headerAttributes = doc.source_header_attributes
-    for (const name of assemblyHeaderAttributes) headerAttributes.$delete(name)
+    for (const name of assemblyHeaderAttributes) doc.source_header_attributes.$delete(name)
   }
   const doctitleIdx = doc.getHeader().getLineNumber() - 1
   const end = doc.getBlocks()[0]?.getLineNumber() ?? lines.length

package/lib/produce-assembly-files.js

@@ -18,6 +18,7 @@ function produceAssemblyFiles (
     doctype: assemblyConfig.doctype,
     insertStartPage: assemblyConfig.insertStartPage,
     rootLevel: assemblyConfig.rootLevel,
+    rootPageStyle: assemblyConfig.rootPageStyle,
     sectionMergeStrategy: assemblyConfig.sectionMergeStrategy,
     navigation: componentVersion.navigation,
     xmlIds: assemblyConfig.xmlIds,
@@ -130,7 +131,7 @@ function includedInNav (items, url) {
 
 function resolveStartPage (contentCatalog, componentVersion, insertStartPage, outlineRoot) {
   const { name: componentName, version } = componentVersion
-  let startPage =
+  const startPage =
     'startPage' in componentVersion
       ? componentVersion.startPage
       : contentCatalog.resolvePage('index.adoc', { component: componentName, version })
@@ -139,22 +140,19 @@ function resolveStartPage (contentCatalog, componentVersion, insertStartPage, ou
       const navtitle = startPage.asciidoc?.navtitle || outlineRoot.content
       Object.assign(outlineRoot, { navtitle, url: startPage.pub.url, urlType: 'internal', roles: ['page'] })
     }
-  } else {
-    startPage = contentCatalog.createFile({
-      src: {
-        component: componentName,
-        version,
-        componentVersion,
-        module: 'ROOT',
-        family: 'page',
-        relative: 'index.adoc',
-        origin: componentVersion.origins?.values().next().value,
-      },
-    })
-    // FIXME remove once upgrading to Antora 3.2.0
-    startPage.path = ['modules', startPage.src.module, startPage.src.family + 's', startPage.src.relative].join('/')
+    return startPage
   }
-  return startPage
+  return contentCatalog.createFile({
+    src: {
+      component: componentName,
+      version,
+      componentVersion,
+      module: 'ROOT',
+      family: 'page',
+      relative: 'index.adoc',
+      origin: componentVersion.origins?.values().next().value,
+    },
+  })
 }
 
 function prepareOutlines (navigation, rootEntry, rootLevel) {

package/lib/util/identify-mutable-attributes.js

@@ -13,7 +13,7 @@ function identifyMutableAttributes (loadAsciiDoc, contentCatalog, referencePage,
       Object.assign({}, referencePage, { contents: Buffer.alloc(0), mediaType: 'text/asciidoc' })
     ),
     contentCatalog,
-    asciidocConfig
+    Object.assign({}, asciidocConfig, { extensions: [], headerOnly: true })
   )
   const immutableAttributeNames = doc.attribute_overrides.$keys()['$+'](['doctype'])
   return Object.entries(doc.getAttributes()).reduce((accum, [name, val]) => {

package/lib/util/rewriter.js

@@ -86,7 +86,7 @@ function rewriteXref (
       }
       if (sourceLocation) {
         const msg = `Cannot create external ${family} reference in assembly because site URL is unknown: ${rawTarget}`
-        doc.logger.warn(doc.createLogMessage(msg, { source_location: sourceLocation }))
+        doc.getLogger().warn(doc.createLogMessage(msg, { source_location: sourceLocation }))
       }
     } else if (~target.indexOf(':')) {
       defaultText = rawTarget // use explicit text so AsciiDoc processor displays it correctly

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-rc.8",
+  "version": "1.0.0-rc.9",
   "description": "A JavaScript library that merges AsciiDoc content from multiple pages in an Antora site into assembly files and delegates to an exporter to convert those files to another format, such as PDF.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -42,9 +42,9 @@
     "js-yaml": "~5.2"
   },
   "devDependencies": {
-    "@antora/asciidoc-loader": "3.2.0-rc.2",
-    "@antora/navigation-builder": "3.2.0-rc.2",
-    "@antora/site-publisher": "3.2.0-rc.2"
+    "@antora/asciidoc-loader": "3.2.0-rc.3",
+    "@antora/navigation-builder": "3.2.0-rc.3",
+    "@antora/site-publisher": "3.2.0-rc.3"
   },
   "engines": {
     "node": ">=20.0.0"