VirtualBox

Changeset 105417 in vbox for trunk/doc


Ignore:
Timestamp:
Jul 19, 2024 11:24:00 AM (10 months ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
164071
Message:

doc/manual: Throw out a lot of meaningless (or outright misleading) content from the ditamap, and do a lot of polishing of the PDF theme. bugref:10705

Location:
trunk/doc/manual
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/dita/UserManual.ditamap

    r105405 r105417  
    22<!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
    33<!-- The bookmap ID is imperative and matched the Jarvis GUID required to build and pretty much do anything -->
    4 <bookmap id="EN-VBOX-7-0-USER" xml:lang="en-US">
    5    <!--
    6          booklibrary renders in bold and is equivalent to title in docbook;
    7          mainbooktitle is not in bold and is equivalent to subtitle
    8 
    9          This information gets updated automatically to match the othermeta title value or PDB entry when you run:
    10          'DitaUtils.py title -d template.ditamap' or 'DitaUtils.py map-prep -d template.ditamap'
    11     -->
     4<bookmap id="EN-VBOX-7-1-USER" xml:lang="en-US">
    125   <booktitle>
    13       <booklibrary>Oracle VM VirtualBox</booklibrary>
    14       <mainbooktitle>User Manual for Release 7.0</mainbooktitle>
     6      <mainbooktitle>Oracle VirtualBox: User Guide for Release 7.1</mainbooktitle>
    157   </booktitle>
    168   <bookmeta>
     
    1810         <published>
    1911            <completed>
    20                <month>November</month>
    21                <year>2022</year>
     12               <month>July</month>
     13               <year>2024</year>
    2214            </completed>
    2315         </published>
    2416      </publisherinformation>
    2517
    26       <!--
    27          The othermeta title is used as the title for the book in Jarvis and in OHC search.
    28          If you don't set this, the value in PDB is used.
    29          The booklibrary and mainbooktitle automatically get updated from this title!
    30 
    31          Use a : character to distinguish booklibrary from mainbooktitle
    32          To make sure the title is correctly set run:
    33          'DitaUtils.py title -d template.ditamap'  or 'DitaUtils.py map-prep -d template.ditamap'
    34       -->
    35       <othermeta name="title" content="Oracle VM VirtualBox: User Guide for Release 7.0"/>
    36 
    37       <!--
    38            Th othermeta pubAlias detemines what the final part of the URL for your book will be (the pubalias in Jarvis).
    39            If you don't set it, it will default to the docid in PDB.
    40       -->
    41          <othermeta name="pubAlias" content="user"/>
    42          <othermeta name="jarvis-url" content="https://docs.oracle.com/en/virtualization/virtualbox/7.0/user/"/>
    43       <!--
    44          For SVN Revision information, you *must* do: `svn propset svn:keywords "Date Author Rev" template.ditamap`
    45          on the ditamap when you first add it. You can automatically handle this by editing ~/.subversion/config
    46          to add a line entry under [auto-props]:
    47          *.ditamap = svn:mime-type=text/xml;svn:keywords=Author Date Id Rev URL;
    48       -->
    49       <othermeta name="revision" content="$Rev$"/>
    50       <othermeta name="rev-date" content="$Date$"/>
    51       <othermeta name="ditaval" content="ohc.ditaval"/>
    52       <!-- The bookpartno matches the part and revision in PDB  -->
    53          <bookid>
    54             <bookpartno>F43655-03</bookpartno>
    55          </bookid>
    56          <bookrights>
    57             <copyrfirst>
    58                <year>2022</year>
    59             </copyrfirst>
    60             <bookowner>
    61                <organization>Oracle and/or its affiliates. All rights reserved.</organization>
    62             </bookowner>
    63          </bookrights>
     18      <bookrights>
     19         <copyrfirst>
     20            <year>2022</year>
     21         </copyrfirst>
     22         <bookowner>
     23            <organization>Oracle and/or its affiliates. All rights reserved.</organization>
     24         </bookowner>
     25      </bookrights>
    6426   </bookmeta>
    65    <!--
    66     Chunking at chapter level is handled automatically by running:
    67     DitaUtils.py chunk -d template.ditamap or 'DitaUtils.py map-prep -d template.ditamap'
    68   -->
    69     <frontmatter>
     27
     28   <!-- Chunking should be set with chunk="to-content" in each chapter.  -->
     29   <frontmatter>
    7030       <mapref href="conkeyrefs.ditamap" format="ditamap" toc="no" processing-role="resource-only"/>
    7131       <booklists>
     
    7434          <tablelist/>
    7535       </booklists>
    76       <preface href="topics/preface.dita">
     36      <preface href="topics/preface.dita" chunk="to-content">
    7737         <topicref href="topics/preface-audience.dita"/>
    7838         <topicref href="topics/preface-reldocs.dita"/>
  • trunk/doc/manual/pdf-theme-UserManual.yaml

    r105299 r105417  
    1717pdf2:
    1818  font:
    19     sans:           'Helvetica, Arial Unicode MS, Tahoma, Batang, SimSun'
    20     serif:          'Times New Roman, Times, Arial Unicode MS, Tahoma, Batang, SimSun'
    21     monospaced:     'DejaVu Sans Mono, Arial Unicode MS, Consolas, Cascadia Mono'
    22     # ^^^ - Important to have proper unicode monospace font so we can use non-breaking hypen (U+2011)
     19    sans:           'Noto Sans'
     20    serif:          'Noto Serif'
     21    monospaced:     'DejaVu Sans Mono'
     22    # ^^^ - Important to have proper unicode monospace font so we can use non-breaking hyphen (U+2011)
    2323    #       in syntax diagrams.
     24    #
     25    # If the PDF contains any use of font "Helvetica" then it might be that the topic nesting is too deep.
     26    # Maximum nesting is 4 (not sure what limits it), but all config for h5 is ignored.
    2427
    2528page:
     
    6770    cmdname:
    6871        color:              $brand-color-primary
     72        font-family:        $pdf2-font-monospaced
    6973        font-weight:        bold
    7074
     
    7983    codeph:
    8084        color:              $brand-color-secondary
     85        font-family:        $pdf2-font-monospaced
    8186        font-size:          '0.9 * from-parent(font-size)'
    8287
     
    8994    cover-title:
    9095        color:              $brand-color-primary
    91         font-size:          36pt
    92         font-weight:        bold
    93         line-height:        1.5
    94         space-before:       195mm
     96        font-family:        $pdf2-font-sans
     97        font-size:          48pt
     98        font-weight:        bold
     99        line-height:        1.3
     100        space-before:       165mm
    95101
    96102    example-title:
     
    100106        caption:
    101107            color:          $brand-color-secondary
     108            font-family:    $pdf2-font-sans
    102109            font-size:      9pt
    103110            font-style:     italic
     
    106113    filepath:
    107114        color:              $brand-color-secondary
     115        font-family:        $pdf2-font-monospaced
    108116
    109117    h1:
    110118        border-after:       solid 2pt $brand-color-inverse
    111119        color:              $brand-color-primary
     120        font-family:        $pdf2-font-sans
    112121        font-size:          18pt
     122        font-weight:        bold
    113123        space-before:       0pt
    114124        padding-top:        0pt
    115125        space-after:        9pt
    116         font-weight:        bold
    117126        title-numbering:    true
    118127
     
    120129        border-after:       solid 1pt $brand-color-inverse
    121130        color:              $brand-color-primary
     131        font-family:        $pdf2-font-sans
    122132        font-size:          16pt
    123133        font-style:         italic
     
    128138    h3:
    129139        color:              $brand-color-primary
     140        font-family:        $pdf2-font-sans
    130141        font-size:          14pt
    131142        font-weight:        bold
     
    135146
    136147    h4:
     148        color:              $brand-color-primary
     149        font-family:        $pdf2-font-sans
    137150        font-size:          12pt
    138151        font-weight:        bold
     
    176189    section-title:
    177190        color:              $brand-color-secondary
     191        font-family:        $pdf2-font-sans
    178192
    179193    shortdesc:
    180194        color:              $brand-color-secondary
    181         font-size:          13pt
    182195        line-height:        1.3
    183196
     
    185198        caption:
    186199            color:          $brand-color-secondary
     200            font-family:    $pdf2-font-sans
    187201            font-size:      9pt
    188202            font-style:     italic
     
    192206        header:
    193207            background-color:   $brand-color-inverse
     208            font-family:    $pdf2-font-monospaced       # Hack for arrow glyphs
    194209
    195210    toc-1:
    196211        color:          $brand-color-primary
    197212        font-family:    $pdf2-font-sans
    198         space-before:   5pt
     213        space-before:   6pt
    199214        start-indent:   0pt
    200215
     
    202217        color:          black
    203218        space-before:   4pt
    204         start-indent:   5pt
     219        start-indent:   12pt
    205220
    206221    toc-3:
    207222        color:          black
    208223        space-before:   2pt
    209         start-indent:   24pt
     224        start-indent:   32pt
    210225
    211226    toc-4:
    212227        color:          black
    213228        space-before:   2pt
    214         start-indent:   40pt
     229        start-indent:   48pt
    215230
    216231    varname:
    217232        color:          $brand-color-secondary
     233        font-family:    $pdf2-font-monospaced
    218234        font-style:     italic
    219235
     
    224240    #
    225241
    226     # We need to specify the font for each of these elements, so we get a monospace
    227     # font capable of doing non-breaking hypen glyps. The default "Courier" does do
    228     # that, at least not on Windows.
     242    # We need to specify the font for each of these elements, so we get a consistent
     243    # monospace font capable of doing non-breaking hyphen glyps. The default "Courier"
     244    # does not do the job, at least not on Windows.
    229245    delim:
    230246        font-family:        $pdf2-font-monospaced
     
    250266    var:
    251267        font-family:        $pdf2-font-monospaced
     268    pre:
     269        font-family:        $pdf2-font-monospaced
     270    userinput:
     271        font-family:        $pdf2-font-monospaced
     272    screen:
     273        font-family:        $pdf2-font-monospaced
     274    systemoutput:
     275        font-family:        $pdf2-font-monospaced
    252276
    253277
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette