Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current Restore this Version View Page History

« Previous Version 2 Next »

Content at the start of a document should be styled using items on the Front tab of the eXtyles style palette. This section describes how to correctly style the front sections of your content.

Document Information: Title Page

The following items may appear on the title page of WTO documents. Note that the only required item is Document Title; other items may or may not be present.

Bold items in the following list are styles that will not be carried through to the XML during the Export process. These items are redundant with metadata that is captured in the eXtyles Document Information dialog, but may be required in the Word document to create PDF.

  • Document Title

  • Document Subtitle

  • Document Type

  • Document Country

  • Document Date

  • Document Version

[[Add screen grab of Word doc]]

Which produces the following XML:

<book-title-group>
<book-title>Optimal Use of Minimally Invasive Glaucoma Surgery</book-title>
<subtitle>A Health Technology Assessment</subtitle>
</book-title-group>

Alternatively, the report subtitle may be run-in to the title following a colon. In this case the entire line should be styled as Report Title, and the Report Subtitle style will not be used.

The Suggested Citation Title should be used if the title that will appear in the suggested citation is different in any way from the report title on the title page. For example, if the title as it appears in the suggested citation will be sentence case rather than title case, the Suggested Citation Title should be used:

Which will produce the following XML:

<book-title-group>
<book-title>Sedative Agents During Medical Procedures: Guidelines</book-title>
<alt-title alt-title-type="sentence-case"><italic toggle="yes">Sedative agents during medical procedures: Guidelines</italic></alt-title>
</book-title-group>

Authors, Group Authors, and Affiliations

Authors

A report that has authors listed will need to have those author names placed immediately below the report title (or, subtitle). Any affiliations associated with the authors should be placed following the author names, on their own lines and styled with the Affiliations paragraph style. For example:

During Author Processing, parts of the author line are identified with unique character styles, which produces the following XML:

<contrib-group content-type="Authors">
<contrib>
<name name-style="western"><surname>Hill</surname><given-names>Shannon</given-names></name>
</contrib> 
<contrib>
<name name-style="western"><surname>McCormack</surname><given-names>Suzanne</given-names></name>
</contrib>
</contrib-group>

Group Authors

Some CADTH reports have authors that belong to specific groups; for example, Clinical Review Authors and Economic Evaluation Authors. These author names should also be placed immediately after the report title (or, subtitle), and the name of the group to which the authors belong should prefix the author line; for example,

As with standard author lines, eXtyles Author Processing will automatically apply character styles to the parts of the authors' names. In this case, affiliation numbers are also identified and styled. However, eXtyles Author Processing is unable to automatically style the group name, shown with blue highlighting in the above example.

This author group information will need to be styled manually. To do this, with your cursor highlight the author group information and select the au_group style from the style drop-down menu on the eXtyles ribbon to apply the correct style:

The resulting XML will look like this:

<contrib-group content-type="Group-Authors">
<role>Clinical Review Authors</role> 
<contrib>
<name><surname>Poitras</surname><given-names>Veronica</given-names><prefix>Dr.</prefix></name>
<xref ref-type="aff" rid="aff1"><sup>1</sup></xref>
</contrib> 
<contrib>
<name><surname>Wells</surname><given-names>Charlotte</given-names></name>
<xref ref-type="aff" rid="aff1"><sup>1</sup></xref></contrib> 
<contrib>
<name><surname>Hutnik</surname><given-names>Cindy</given-names><prefix>Dr.</prefix></name>
<xref ref-type="aff" rid="aff2"><sup>2</sup></xref>
</contrib>
</contrib-group>

Affiliations

Author affiliations should be placed immediately after the author (or, group author) lines. eXtyles Author Processing will style the affiliation number, and during XLM export the affiliation number will be associated (linked) with the proper affiliation.

Cover and Boilerplate Text

Cover Text

Some CADTH reports will include summary text on the cover that will be displayed with a black marginal bar in the PDF. So that this cover text can be rendered correctly, the XML will need to include distinctive markup. To achieve this, use the Cover Heading 1, Cover Text, and Cover List Level 1 styles, as appropriate. For example,

Produces the following XML (note the book-part-type="cover-text" attribute for the front-matter-part, which indicates that this text is a separate design element from other front content):

<front-matter>
<front-matter-part book-part-type="cover-text">
<named-book-part-body>
<p>Indication: For the treatment of major depressive disorder in adults.</p>
<sec id="S1">
<title>Recommendation</title>
<p>The CADTH Canadian Drug Expert Committee recommends that vortioxetine be reimbursed for the treatment of major depressive disorder in adults if the following conditions are met.</p>
</sec>
<sec id="S2">
<title>Conditions for Reimbursement</title>
<list id="L1" list-type="order">
<list-item><p>Reimburse in a similar manner to other antidepressants for the treatment of patients with major depressive disorder.</p></list-item>
<list-item><p>The drug plan cost of treatment with vortioxetine should not exceed the drug plan cost of the least costly antidepressant currently reimbursed.</p></list-item></list>
</sec>
</named-book-part-body>
</front-matter-part>
...

Boilerplate Text

Boilerplate content in the front matter should be styled using the Boilerplate style. This ensures that a unique identifier is included in the XML, which will facilitate the correct layout of the content in the PDF. For example,

Will produce the following XML (note the book-part-type="boilerplate" attribute for the front-matter-part):

<front-matter-part book-part-type="boilerplate">
<named-book-part-body>
<p><bold>Cite As:</bold> Body weight modification interventions for chronic non-cancer pain: a review of clinical 
effectiveness. Ottawa: CADTH; 2020 Mar. (CADTH rapid response report: summary with critical appraisal).</p>
<p><bold>ISSN:</bold> 1922-8147 (online)</p>
<p><bold>Disclaimer:</bold> The information in this document is intended to help Canadian health care decision-makers, 
health care professionals, health systems leaders, and policy-makers make well-informed decisions and thereby improve the 
quality of health care services. While patients and others may access this document, the document is made available for 
informational purposes only and no representations or warranties are made with respect to its fitness for any particular 
purpose. The information in this document should not be used as a substitute for professional medical advice or as a 
substitute for the application of clinical judgment in respect of the care of a particular patient or other professional 
judgment in any decision-making process. The Canadian Agency for Drugs and Technologies in Health (CADTH) does not endorse 
any information, drugs, therapies, treatments, products, processes, or services.</p>

Abbreviations and Glossary

Lists of abbreviations should not be formatted in tables; rather, they should be formatted as lists with a tab or other strong character separating the term from the definition. For example,

During XML export, eXtyles will automatically mark the term and the definition:

<def-list list-type="simple" list-content="abbreviations">
<title>Abbreviations</title>
<def-item><term>AE</term><def><p>adverse event</p></def></def-item>
<def-item><term>AGI</term><def><p>Ahmed glaucoma implant</p></def></def-item>
<def-item><term>ALT</term><def><p>argon laser trabeculoplasty</p></def></def-item>
<def-item><term>BGI</term><def><p>Baerveldt glaucoma implant</p></def></def-item>
<def-item><term>BCVA</term><def><p>best-corrected visual acuity</p></def></def-item>
...

Glossary sections should be styled with the appropriate glossary styles on the Front tab of the eXtyles style palette:

Again, note that the term and definition section is not formatted as a table. The resulting XML is:

<glossary id="glossary1">
<title>Glossary</title>
<p>The economic analysis in this report uses a four-letter acronym convention to label the screening strategies. Each letter corresponds to a type of screening scheduled at each of the trimesters and during labour and delivery in a chronological order; whereby, the first letter corresponds to the first trimester, the second letter corresponds to the second trimester, the third letter corresponds to the third trimester, and the fourth letter corresponds to labour and delivery. Each letter is coded in the following manner:</p>
<def-list list-content="glossary">
<def-item><term><bold>N</bold></term><def><p>no screening</p></def></def-item>
<def-item><term><bold>M</bold></term><def><p>mixed screening of age-based subgroups of the pregnant population (i.e., those who are younger than 25 years and those who are 25 years or older) based on other criteria (e.g., prior screening history).</p></def></def-item>
<def-item><term><bold>T</bold></term><def><p>age-targeted screening; whereby, only the pregnant population that included those who are younger than 25 years are screened.</p></def></def-item>
<def-item><term><bold>U</bold></term><def><p>universal screening</p></def></def-item>
</def-list>
<p>For example, screening strategy TNUM would indicate age-targeted screening in the first trimester, no screening in the second trimester, universal screening in the third trimester, and mixed screening during labour and delivery.</p>
</glossary>