/usr/share/qt5/doc/qdoc/05-qdoc-commands-documentstructure.html is in qttools5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdoc-manual-markupcmds.qdoc -->
<title>Document Structure | QDoc Manual 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Document Structure</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<link rel="prev" href="04-qdoc-commands-textmarkup.html" />
<link rel="next" href="06-qdoc-commands-includecodeinline.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="04-qdoc-commands-textmarkup.html">Text Markup</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="06-qdoc-commands-includecodeinline.html">Including Code Inline</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#part">\part</a></li>
<li class="level1"><a href="#chapter">\chapter</a></li>
<li class="level1"><a href="#section1">\section1</a></li>
<li class="level1"><a href="#section2">\section2</a></li>
<li class="level1"><a href="#section3">\section3</a></li>
<li class="level1"><a href="#section4">\section4</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Document Structure</h1>
<span class="subtitle"></span>
<!-- $$$05-qdoc-commands-documentstructure.html-description -->
<div class="descr"> <a name="details"></a>
<p>The document structuring commands are for dividing your document into sections. QDoc supports six kinds of sections: <code>\part</code>, <code>\chapter</code>, <code>\section1</code>, <code>\section2</code>, <code>\section3</code>, and <code>\section4</code>. The <code>\section1..4</code> commands are the most useful. They correspond to the traditional section, subsection, etc used in outlining.</p>
<a name="part-command"></a><a name="part"></a>
<h2 id="part">\part</h2>
<p>The \part command is intended for use in a large document, like a book.</p>
<p>In general a document structuring command considers everything that follows it until the first line break as its argument. The argument is rendered as the unit's title. If the title needs to be spanned over several lines, make sure that each line (except the last one) is ended with a backslash.</p>
<p>In total, there are six levels of sections in QDoc: <code>\part</code>, <code>\chapter</code>, <code>\section1</code>, <code>\section2</code>, <code>\section3</code> and <code>\section4</code>. <code>\section1</code> to <code>\section4</code> correspond to the traditional section, subsection, subsubsection and subsubsubsection.</p>
<p>There is a strict ordering of the section units:</p>
<pre class="cpp">
part
<span class="operator">|</span>
chapter
<span class="operator">|</span>
section1
<span class="operator">|</span>
section2
<span class="operator">|</span>
section3
<span class="operator">|</span>
section4
</pre>
<p>For example, a <code>section1</code> unit can only appear as the top level section or inside a <code>chapter</code> unit. Skipping a section unit, for example from <code>part</code> to <code>section1</code>, is not allowed.</p>
<p>You can <i>begin</i> with either of the three: <code>part</code>, <code>chapter</code> or <code>section1</code>.</p>
<pre class="cpp">
<span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
\part Basic <span class="type"><a href="../qtcore/qt.html">Qt</a></span>
This is the first part<span class="operator">.</span>
\chapter Getting Started
This is the first part<span class="char">'s first chapter.
\section1 Hello Qt
This is the first chapter'</span>s first section<span class="operator">.</span>
\section1 Making Connections
This is the first chapter<span class="char">'s second section.
\section1 Using the Reference Documentation
This is the first chapter'</span>s third section<span class="operator">.</span>
\chapter Creating Dialogs
This is the first part<span class="char">'s second chapter.
\section1 Subclassing QDialog
This is the second chapter'</span>s first section<span class="operator">.</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
\part Intermediate <span class="type"><a href="../qtcore/qt.html">Qt</a></span>
This is the second part<span class="operator">.</span>
\chapter Layout Management
This is the second part<span class="char">'s first chapter.
\section1 Basic Layouts
This is the first chapter'</span>s first section<span class="operator">.</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="operator">*</span> <span class="operator">/</span>
</pre>
<p>QDoc renders this as:</p>
<blockquote> <a name="Basic Qt">
<h1>Basic Qt</h1>
</a>
<p>This is the first part.</p>
<a name="Getting started">
<h2>Getting Started</h2>
</a>
This is the first part's first chapter.</p>
<a name="Hello Qt">
<h3>Hello Qt</h3>
</a>
<p>This is the first chapter's first section.</p>
<a name="Making Connections">
<h3>Making Connections</h3>
</a>
<p>This is the first chapter's second section.</p>
<a name="Using the Reference Documentation">
<h3>Using the Reference Documentation</h3>
</a>
<p>This is the first chapter's third section.</p>
<a name="Creating Dialogs">
<h2>Creating Dialogs</h2>
</a>
<p>This is the first part's second chapter.</p>
<a name="Subclassing QDialog">
<h3>Subclassing QDialog</h3>
</a>
<p>This is the second chapter's first section.</p>
...
<a name="Intermediate Qt">
<h1>Intermediate Qt</h1>
</a>
<p>This is the second part.</p>
<a name="Layout Management">
<h2>Layout Management</h2>
</a>
<p>This is the second part's first chapter.</p>
<a name="Basic Layouts">
<h3>Basic Layouts</h3>
</a>
<p>This is the first chapter's first section.</p>
...
</blockquote>
<p>Each section is a logical unit in the document. The section heading appears in the automatically generated table of contents that normally appears in the upper right-hand corner of the page.</p>
<a name="chapter-command"></a><a name="chapter"></a>
<h2 id="chapter">\chapter</h2>
<p>The \chapter command is intended for use in larger documents, and divides the document into chapters.</p>
<p>See <a href="05-qdoc-commands-documentstructure.html#part">\part</a> for an explanation of the various section units, command argument, and rendering.</p>
<a name="sectionone-command"></a><a name="section1"></a>
<h2 id="section1">\section1</h2>
<p>The \section1 command starts a new section.</p>
<p>See <a href="05-qdoc-commands-documentstructure.html#part">\part</a> for an explanation of the various section units, command argument, and rendering.</p>
<a name="sectiontwo-command"></a><a name="section2"></a>
<h2 id="section2">\section2</h2>
<p>The \section2 command starts a new section.</p>
<p>See <a href="05-qdoc-commands-documentstructure.html#part">\part</a> for an explanation of the various section units, command argument, and rendering.</p>
<a name="sectionthree-command"></a><a name="section3"></a>
<h2 id="section3">\section3</h2>
<p>The \section3 command starts a new section.</p>
<p>See <a href="05-qdoc-commands-documentstructure.html#part">\part</a> for an explanation of the various section units, command argument, and rendering.</p>
<a name="sectionfour-command"></a><a name="section4"></a>
<h2 id="section4">\section4</h2>
<p>The \section4 command starts a new section.</p>
<p>See <a href="05-qdoc-commands-documentstructure.html#part">\part</a> for an explanation of the various section units, command argument, and rendering.</p>
</div>
<!-- @@@05-qdoc-commands-documentstructure.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="04-qdoc-commands-textmarkup.html">Text Markup</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="06-qdoc-commands-includecodeinline.html">Including Code Inline</a>
</p>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|