Fix doc toc misses
[shapes.git] / doc / parts / guides / text.sxml
blob0737c01d3255905891851207997cf8bf5f78abbb
1 <!-- This file is part of Shapes.                                           -->
2 <!--                                                                        -->
3 <!-- Shapes is free software: you can redistribute it and/or modify         -->
4 <!-- it under the terms of the GNU General Public License as published by   -->
5 <!-- the Free Software Foundation, either version 3 of the License, or      -->
6 <!-- any later version.                                                     -->
7 <!--                                                                        -->
8 <!-- Shapes is distributed in the hope that it will be useful,              -->
9 <!-- but WITHOUT ANY WARRANTY; without even the implied warranty of         -->
10 <!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          -->
11 <!-- GNU General Public License for more details.                           -->
12 <!--                                                                        -->
13 <!-- You should have received a copy of the GNU General Public License      -->
14 <!-- along with Shapes.  If not, see <http://www.gnu.org/licenses/>.        -->
15 <!--                                                                        -->
16 <!-- Copyright 2014 Henrik Tidefelt                                         -->
18 <book>
19   <title>Text</title>
20   <description>
21     <p>Producing typeset text.</p>
22   </description>
23   <meta-selflink><guide-href name="text" /></meta-selflink>
24   <base href=<!--#expand-next-string-->"$(BASE)" />
25   <examples-home href=<!--#expand-next-string-->"$(EXAMPLES)" />
26   <shapes-version number=<!--#expand-next-string-->"$(SHAPES_VERSION)" />
27   <up-link><a part="guides">User's guide index</a></up-link>
28   <external>
29     <!--#include virtual="^/toc.xml" -->
30   </external>
31   <top>
32     <p><str-Shapes /> provides an interface to the text capabilities of <str-PDF />.  Compared to using <str-LaTeX /> for typesetting, this will compile faster and yield smaller output files, while <str-LaTeX /> is your friend if you need to typeset maths or simply want typesetting consistency with other material produced using <str-LaTeX />.</p>
34     <p>This guide is not yet written.  In the meantime, please refer to <named-statetype name="Text" />, and the silly example below.</p>
36 <example-with-output title="Font metrics and kerning" internal-id="guides:text:fontmeterdemo">
37 <image pdf="features/fontmeterdemo_3.pdf" jpg="features/fontmeterdemo_y_big.jpg" />
38 <source file="features/fontmeterdemo.shape">
39 <![CDATA[<!--#include depth="0" virtual="$(BUILDDIR)$(EXAMPLES)features/fontmeterdemo.shape" -->]]>
40 </source>
41 <caption>
42   <p>Using a <named-statetype name="Text" /> state for producing typeset text, and then show that the computed bounding box is correct.</p>
43 </caption>
44 </example-with-output>
45   </top>
47 </book>