OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Specifications for OASIS spec and committee note documents


OASIS has agreed to work with the DITA TC to develop formal style specifications for its documents: specifications and committee notes. This will substantially cut down the churn that we have traditionally experienced around style sheets.

I said that the DITA TC will provide an initial draft, and then DITA TC representatives will meet with OASIS to discuss and refine the document.

Anyone have a good template for documenting style sheet requirements?

I'm starting with the DITA topic that is attached and adding content. Having a robust template will also enable us to be aware of differences/similarities between spec and committee note plug-in, eventually enabling us to streamline the plug-ins.

Any thoughts, recommendations, or help (Alan?) much appreciated.

--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="reference_trt_wgh_zgb">
    <title>Style specifications for the OASIS committee note</title>
    <shortdesc></shortdesc>
    <refbody>
        <section>
            <title>Basic settings</title>
            <table frame="all" rowsep="1" colsep="1">
                <title>Fonts</title>
                <tgroup cols="3">
                    <colspec colname="c1" colnum="1" colwidth="1*"/>
                    <colspec colname="c2" colnum="2" colwidth="1*"/>
                    <colspec colname="c3" colnum="3" colwidth="1*"/>
                    <thead>
                        <row>
                            <entry>Property</entry>
                            <entry>Value</entry>
                            <entry>Notes</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry>Font: Serif</entry>
                            <entry>Liberation</entry>
                            <entry>For HTML output, we need to specify fallback fonts</entry>
                        </row>
                        <row>
                            <entry>Font: San-serif</entry>
                            <entry>Liberation Sans</entry>
                            <entry>For HTML output, we need to specify fallback fonts</entry>
                        </row>
                        <row>
                            <entry>Font: Monospaced</entry>
                            <entry>Liberation Monospace</entry>
                            <entry>For HTML output, we need to specify fallback fonts</entry>
                        </row>
                        <row>
                            <entry>Default font size</entry>
                            <entry>11 pt</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Default small font size</entry>
                            <entry>10 pt</entry>
                            <entry>Used in tables; might not need to be specified / is too
                                granular</entry>
                        </row>
                        <row>
                            <entry>Default monospace font size</entry>
                            <entry>?</entry>
                            <entry>Used in code samples; might not need to be specified / is too
                                granular</entry>
                        </row>
                        <row>
                            <entry>Font line height</entry>
                            <entry>1.3</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Font color</entry>
                            <entry>#000000</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Font weight</entry>
                            <entry>normal</entry>
                            <entry/>
                        </row>
                    </tbody>
                </tgroup>
            </table>
            <table frame="all" rowsep="1" colsep="1">
                <title>Page settings</title>
                <tgroup cols="3">
                    <colspec colname="c1" colnum="1" colwidth="1*"/>
                    <colspec colname="c2" colnum="2" colwidth="1*"/>
                    <colspec colname="c3" colnum="3" colwidth="1*"/>
                    <thead>
                        <row>
                            <entry>Propery</entry>
                            <entry>Value</entry>
                            <entry>Notes</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry>Page size</entry>
                            <entry>8 x 11 in</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Margin: Top</entry>
                            <entry>1in</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Margin: Bottom</entry>
                            <entry>1in</entry>
                            <entry/>
                        </row>
                        <row>
                            <entry>Margin: Left</entry>
                            <entry>1.25in</entry>
                            <entry>Does OASIS want this to be 1 in?</entry>
                        </row>
                        <row>
                            <entry>Margin: Right</entry>
                            <entry>1.25in</entry>
                            <entry>Does OASIS want this to be 1 in?</entry>
                        </row>
                    </tbody>
                </tgroup>
            </table>
        </section>
        <section>
            <title>Cover page</title>
            <p/>
        </section>
        <table frame="all" rowsep="1" colsep="1">
            <title>Cover page</title>
            <tgroup cols="3">
                <colspec colname="c1" colnum="1" colwidth="1*"/>
                <colspec colname="c2" colnum="2" colwidth="1*"/>
                <colspec colname="c3" colnum="3" colwidth="1*"/>
                <thead>
                    <row>
                        <entry>Section label</entry>
                        <entry>Specifications</entry>
                        <entry>Section content</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>&lt;documentTitle> + Version &lt;x></entry>
                        <entry>24 pt bold san-serif; #446CAA</entry>
                        <entry morerows="14">
                            <ul>
                                <li>11 pt normal san-serif</li>
                                <li>Color #000000, except for hyperlinks which are blue</li>
                                <li>Test is flush left against margins (including list items and
                                    content of <xmlelement>dd</xmlelement> elements</li>
                                <li>Hyperlinks are underlined but not italicized</li>
                            </ul>
                        </entry>
                    </row>
                    <row>
                        <entry>Committee Note &lt;0x></entry>
                        <entry>18 pt bold san-serif;  #446CAA</entry>
                    </row>
                    <row>
                        <entry>&lt;Day Month Year></entry>
                        <entry>18 pt bold san-serif;  #446CAA</entry>
                    </row>
                    <row>
                        <entry>Specification URIs</entry>
                        <entry>14 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>This version:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Previous version:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Latest version:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Technical Committee</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Chair:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Editors:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Additional artifacts</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Related work:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Abstract:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Status:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                    <row>
                        <entry>Citation format:</entry>
                        <entry>12 pt bold san-serif; #446CAA</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
        <section>
            <title>Headers</title>
            <p/>
        </section>
        <section>
            <title>Footers</title>
            <p/>
        </section>
        <section>
            <title>Body content</title>
            <p/>
        </section>
    </refbody>
</reference>


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]