src/main/org/freemarker/docgen/templates/util.ftl

<#ftl nsPrefixes={"D":"http://docbook.org/ns/docbook"}>

<#function getOptionalTitleAsString node>
  <#return titleToString(getOptionalTitleElement(node))>
</#function>

<#function getOptionalTitleElement node preferTitleAbbrev=false>
  <#if preferTitleAbbrev>
    <#local result = node.info.titleabbrev>
  </#if>
  <#if !result?hasContent><#local result = node.title></#if>
  <#if !result?hasContent><#local result = node.info.title></#if>
  <#if !result?hasContent>
     <#return ''>
  </#if>
  <#return result>
</#function>

<#function getRequiredTitleElement node preferTitleAbbrev=false>
  <#local result = getOptionalTitleElement(node, preferTitleAbbrev)>
  <#if !result?hasContent>
    <#stop "Required \"title\" child element missing for element \""
        + node?nodeName + "\".">
  </#if>
  <#return result>
</#function>

<#function getRequiredTitleAsString node>
  <#return titleToString(getRequiredTitleElement(node))>
</#function>

<#function getOptionalSubtitleElement node>
  <#local result = node.subtitle>
  <#if !result?hasContent><#local result = node.info.subtitle></#if>
  <#if !result?hasContent>
    <#return ''>
  </#if>
  <#return result>
</#function>

<#function getOptionalSubtitleAsString node>
  <#return titleToString(getOptionalSubtitleElement(node))>
</#function>

<#function titleToString titleNode>
  <#if !titleNode?hasContent>
    <#-- Used for optional title -->
    <#return ''>
  </#if>
  <#if !titleNode?isNode>
    <#-- Just a string... -->
    <#return titleNode>
  </#if>

  <#local res = "">
  <#list titleNode?children as child>
    <#if child?nodeType == "text">
      <#local res += child>
    <#elseIf child?nodeType == "element">
      <#local name = child?nodeName>
      <#if ["literal", "classname", "methodname", "package", "replaceable", "emphasis", "phrase",
            "olink", "link"]?seqContains(name)>
        <#local res += titleToString(child)>
      <#elseIf name == "quote">
        <#local res = "\x201C" + titleToString(child) + "\x201D">
      <#elseIf name != "subtitle">
        <#stop 'The "${name}" in titles is not supported by Docgen.'>
      </#if>
    </#if>
  </#list>

  <#return res>
</#function>

<#-- "docStructElem" is a part, chapter, section, etc., NOT a title element -->
<#function getTitlePrefix docStructElem, extraSpacing=false, longForm=false>
  <#local prefix = docStructElem.@docgen_title_prefix[0]!>
  <#if !prefix?hasContent>
    <#return "">
  </#if>

  <#local type = docStructElem?nodeName>

  <#local spacer = ": ">


  <#if type == "chapter">
    <#return longForm?string("Chapter ", "") + prefix + spacer>
  <#elseIf type == "appendix">
    <#return longForm?string("Appendix ", "") + prefix + spacer>
  <#elseIf type == "part">
    <#return longForm?string("Part ", "") + prefix + spacer>
  <#elseIf type == "article">
    <#return longForm?string("Article ", "") + prefix + spacer>
  <#else>
    <#return prefix + spacer>
  </#if>
</#function>

<#macro invisible1x1Img>
  <img src="docgen-resources/img/none.gif" width="1" height="1" alt="" hspace="0" vspace="0" border="0"/><#t>
</#macro>