topics with keyscope not printed in PDF

Oxygen general issues.
Kaylee
Posts: 6
Joined: Fri May 06, 2022 1:47 pm

topics with keyscope not printed in PDF

Post by Kaylee »

Hi,
I have applied different keyscopes to two topics and expect the two topics to be both printed in PDF. But the printed TOC shows only the section number and the main content does not include the referencing topic.
Is any more setting required to show both topics?
image.png
image.png
Thanks,
Kaylee
You do not have the required permissions to view the files attached to this post.
julien_lacour
Posts: 665
Joined: Wed Oct 16, 2019 3:47 pm

Re: topics with keyscope not printed in PDF

Post by julien_lacour »

Hello Kaylee,

Could you provide us the ditamap structure related to the problem? I cannot reproduce it on my side.

Regards,
Julien
Kaylee
Posts: 6
Joined: Fri May 06, 2022 1:47 pm

Re: topics with keyscope not printed in PDF

Post by Kaylee »

Hi Julien,
I tested several times. It seems if I include a frontmatter topic in the map, this issue will occur. If I exclude the frontmatter topic from the map, the PDF output is normal. Do you have any idea of the reason?
BTW, should I send you the entire project or just the screenshot of the map structure?
The following shows a screenshot of the map structure.
image.png
This is the screenshot of the TOC in the PDF output.
image.png
Thanks,
Kaylee
You do not have the required permissions to view the files attached to this post.
julien_lacour
Posts: 665
Joined: Wed Oct 16, 2019 3:47 pm

Re: topics with keyscope not printed in PDF

Post by julien_lacour »

Hello Kaylee,

Could you provide the ditamap structures as an XML text? At least the referenced ditamap.
Like this I can check how the attributes are set in the file.

Regards,
Julien
Kaylee
Posts: 6
Joined: Fri May 06, 2022 1:47 pm

Re: topics with keyscope not printed in PDF

Post by Kaylee »

Hi Julien,
Sure. Following shows the XML text of the referenced ditamap.

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
<bookmap>
    <booktitle>
        <mainbooktitle><ph keyref="product"/> Guide</mainbooktitle>
    </booktitle>
    <frontmatter>
        <notices href="../common/common.reuse/c_vpu_legal_notices_d.dita"/>
    </frontmatter>
    <chapter href="concepts/c_memory_mapped_programming_bus_interfaces.dita">
        <topicref href="concepts/c_apb_slave_interface.dita">
            <topicref href="reference/r_apb_slave_interface_signal.dita" keyscope="apb0.scope">
                <keydef keys="apb">
                    <topicmeta>
                        <keywords>
                            <keyword>APB</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
                <keydef keys="paddr_s">
                    <topicmeta>
                        <keywords>
                            <keyword>PADDR_s</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
                <keydef keys="pprot_s">
                    <topicmeta>
                        <keywords>
                            <keyword>PPROT_s</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
            </topicref>
            <topicref href="reference/r_apb_slave_interface_signal.dita" keyscope="apb1.scope">
                <keydef keys="apb">
                    <topicmeta>
                        <keywords>
                            <keyword>APB1</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
                <keydef keys="paddr_s">
                    <topicmeta>
                        <keywords>
                            <keyword>PADDR_s1</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
                <keydef keys="pprot_s">
                    <topicmeta>
                        <keywords>
                            <keyword>PPROT_s1</keyword>
                        </keywords>
                    </topicmeta>
                </keydef>
            </topicref>
        </topicref>
    </chapter>
</bookmap>
Thanks,
Kaylee
julien_lacour
Posts: 665
Joined: Wed Oct 16, 2019 3:47 pm

Re: topics with keyscope not printed in PDF

Post by julien_lacour »

Hi Kaylee,

I tried your structure in <oXygen/> XML Editor 26.1, build 2024091606 with the default DITA Map PDF - based on HTML5 & CSS scenario (with the args.css.param.numbering="deep" parameter set) and I did get the correct output:
image.png
Could you indicate which version of Oxygen you are using?
Are you using other parameters than args.css.param.numbering?
Are you using any custom CSS stylesheets?

Regards,
Julien
You do not have the required permissions to view the files attached to this post.
Kaylee
Posts: 6
Joined: Fri May 06, 2022 1:47 pm

Re: topics with keyscope not printed in PDF

Post by Kaylee »

Hi Julien,
The Oxygen version I use is as follows:
image.png
I did use a custom css template. Is there any constraint on the css template?
image.png
BTW, not only the TOC does not show the section title but also the main text excludes the sections without titles.
I included the xml of css template for your reference. Thanks for your help!

Code: Select all

:root {
    font-family: "Calibri", Symbol !important;
}

@page {
    @top-left {
        font-family: "Calibri", Symbol !important;
        font-size: 12pt;
    }
    @top-right {
        font-family: "Calibri", Symbol !important;
        font-size: 12pt;
    }
    @top-center {
        font-family: "Calibri", Symbol !important;
        font-size: 12pt;
    }
    @top-left-corner {
        font-family: "Calibri", Symbol !important;
    }
    @top-right-corner {
        font-family: "Calibri", Symbol !important;
    }

    @bottom-left {
        font-family: "Calibri", Symbol !important;
        font-size: 9pt;
    }
    @bottom-right {
        font-family: "Calibri", Symbol !important;
        font-size: 9pt;
    }
    @bottom-center {
        font-family: "Calibri", Symbol !important;
        font-size: 9pt;
    }
    @bottom-left-corner {
        font-family: "Calibri", Symbol !important;
    }
    @bottom-right-corner {
        font-family: "Calibri", Symbol !important;
    }
}

@page {
    size: A4;
    margin: 1.8cm;
}

/* spacing between lines */
*[class ~= 'topic/topic'],
*[class ~= 'topic/body'],
*[class ~= 'topic/title'] {
    line-height: 1.4;
    padding-top: 3pt;
    padding-top: 3pt;
    margin-top: 0;
    margin-bottom: 0;
}

/* toc */
*[class ~= "toc/title"] {
    font-size: 16pt;
    font-weight: bold
}

*[class ~= "toc/title"][empty]:before {
    content: "Table of Contents";
}

/* special elements */
*[outputclass ~= "security_level_d"] {
    color: #FF6600 !important;
    font-weight: bold
}

/* Customize footnote calls, inside the table. */
*[outputclass ~= 'table-fn-call'] {
    color: #B60005;
    text-decoration: none;
    vertical-align: super;
    vertical-align: 35%;
    font-size: 8pt;
    line-height: 0;
}

*[class ~= 'ph'][class ~= 'sup'] {
    vertical-align: super;
    vertical-align: 35%;
    font-size: 6.94pt;
    line-height: 0;
}

/* Hide the "on page .." text that follows xrefs. */
*[outputclass ~= 'table-fn-call']:after {
    display: none;
}

/* Customize the list containing all the table footnotes. */
*[outputclass ~= 'table-fn-container'] {
    border-top: 0pt solid black;
}

/* Customize footnotes display, below the table. */
*[outputclass ~= 'table-fn'] {
    font-size: 9pt;
    text-align: justify
}
*[outputclass ~= 'table-fn']::marker {
    font-size: 9pt;
}

*[class ~= "topic/term"] {
    color: #B60005 !important;
    font-style: normal
}

/* links */
*[class ~= "topic/xref"][href]:after,
*[class ~= "topic/link"][href]:after {
    content: none !important;
}

*[class ~= "topic/xref"][href],
*[class ~= "topic/link"][href] {
    color: #B60005;
}

.related-links a,
.related-links a:visited,
[class ~= "topic/link"],
[class ~= "topic/xref"],
a,
a:hover,
a:visited {
    color: #B60005;
    font-weight: normal
}

/* tables */
*[class ~= "topic/thead"] {
    background-color: #D9D9D9 !important;
    text-align: left;
    font-size: 10pt
}

table {
    border: 0.75pt #BFBFBF;
    border-collapse: collapse;
    width: 90%;
    column-width: auto;
    margin-left: auto;
    margin-right: auto;
}

*[class ~= "topic/table"] {
    hyphens: auto;
}

tr,
td,
th {
    border: 0.75pt #BFBFBF;
    break-inside: auto;
}

*[class ~= "topic/table"] > *[class ~= "topic/title"] {
    display: table-caption;
    text-align: center;
    font-size: 10pt;
}

*[class ~= "topic/entry"],
*[class ~= "topic/stentry"] {
    font-size: 10pt;
    text-align: justify;
    -oxy-borders-conditionality: retain;
}

/* topics */
.shortdesc {
    font-size: 10pt;
}

*[class ~= "topictitle1"] {
    font-size: 16pt;
    font-weight: bold;
    page-break-before: always;
    padding-top: 32pt;
    padding-bottom: 6pt;
    border-bottom: 0.75pt solid #bfbfbf;
}

*[class ~= "topictitle2"] {
    font-size: 14pt;
    font-weight: bold;
    page-break-before: always;
    padding-top: 32pt;
    padding-bottom: 0;
}

*[class ~= "topictitle3"] {
    font-size: 12pt;
    font-weight: bold;
    padding-top: 32pt;
    padding-bottom: 8pt;
}

*[class ~= "topictitle4"] {
    font-size: 11pt;
    font-weight: bold;
    padding-top: 32pt;
    padding-bottom: 8pt;
}

*[class ~= "topictitle5"] {
    font-size: 10pt;
    font-weight: bold;
    padding-top: 32pt;
    padding-bottom: 8pt;
}

*[class ~= "topic/p"] {
    font-size: 10pt;
    text-align: justify
}

*[class ~= "placeholder/tablelist"] > *[class ~= "topic/title"],
*[class ~= "placeholder/figurelist"] > *[class ~= "topic/title"] {
    font-size: 16pt;
    font-weight: bold
}

/* figures */
*[class ~= "topic/fig"] > *[class ~= "topic/title"] {
    display: table-caption;
    text-align: center;
    font-weight: bold;
    font-size: 10pt;
}

/* caption */
caption {
    padding-top: 3pt;
    padding-bottom: 3pt;
}

/* lists */
ul {
    font-size: 10pt;
    break-inside: auto;
    padding-left: 0;
    list-style-position: outside;
}

ol {
    font-size: 10pt;
    break-inside: auto;
    padding-left: 0;
    list-style-position: outside;
}

li {
    font-size: 10pt;
    break-inside: auto;
    list-style-position: outside;
    padding: 0 0 0 0.2cm;
    margin: 0 0 0 0.2cm;
}

*[class ~= "topic/ul"],
*[class ~= "topic/ol"],
.entry ol,
.entry ul
{
    margin: 0cm;
}

.li p {
    margin-top: 0;
    margin-bottom: 0;
    padding-top: 0;
    padding-bottom: 0;
}

.entry p {
    margin-top: 0;
    margin-bottom: 0;
    padding-top: 0;
    padding-bottom: 0;
}

/* codeblock */
*[class ~= 'pr-d/codeblock'],
*[class ~= 'codeblock'],
*[class ~= 'pr-d/codeph'],
*[class ~= 'codeph'] {
    font-family: Consolas;
    font-size: 9pt;
}

.filepath {
    font-family: Consolas;
    font-size: 9pt;
}

/* mini TOC */
*[class ~= "chapter/minitoc-desc"],
*[class ~= "chapter/minitoc-links"] {
    display: block;
    width: 100%;
}

*[class ~= "chapter/minitoc-links"] *[class ~= "topic/link"] {
    display:list-item;
    list-style-type: disc;
    color: #000000;
    margin: 0 0 0 0.2cm;
    padding: 0 0 0 0.2cm;
}

/* glossary */
*[class ~= "glossentry/glossterm"] {
    page-break-before: auto;
    font-size: 14pt;
    
}

*[class ~= "glossentry/glossdef"] {
    font-size: 10pt;
    
}
Thanks,
Yuan
You do not have the required permissions to view the files attached to this post.
julien_lacour
Posts: 665
Joined: Wed Oct 16, 2019 3:47 pm

Re: topics with keyscope not printed in PDF

Post by julien_lacour »

Hi Yuan,

I also tried with <oXygen/> XML Editor 25.1, build 2023110913 and the Table of Contents is still OK on my side.
Could you try to update to the last Maintenance Build? I see that your build (2023042509) is different than mine (2023110913) maybe the problem has been fixed.
If not, could you try to debug your CSS to see if the topics titles are present in the intermediary merged.html file? Maybe you have an additional CSS rule that hides these titles.

Regards,
Julien
Kaylee
Posts: 6
Joined: Fri May 06, 2022 1:47 pm

Re: topics with keyscope not printed in PDF

Post by Kaylee »

Thanks for your help, Julien!
I will try your suggestions.
Post Reply