AuroraMiddleware/harfbuzz
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
9aa865dcc6
harfbuzz/docs/harfbuzz-docs.xml

168 lines
11 KiB
XML
Raw Normal View History

[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<title>HarfBuzz Manual</title>
Intro from freedesktop.org/wiki/Software/HarfBuzz/
2015-12-22 20:26:20 +00:00
<abstract>
<title>HarfBuzz</title>
<graphic fileref="HarfBuzz.png" format="PNG" align="center"/>
<para>
HarfBuzz is an <ulink url="http://www.microsoft.com/typography/otspec/">OpenType</ulink>
Docs: move harfbuzz-ng-vs-old discussion down below the TOC; put in note.
2018-10-11 20:40:08 +00:00
text shaping engine. Using the HarfBuzz library allows
programs to convert a sequence of Unicode input text into
properly formatted and positioned output&mdash;for any writing
system and language.
Intro from freedesktop.org/wiki/Software/HarfBuzz/
2015-12-22 20:26:20 +00:00
</para>
Docs: move harfbuzz-ng-vs-old discussion down below the TOC; put in note.
2018-10-11 20:40:08 +00:00
Intro from freedesktop.org/wiki/Software/HarfBuzz/
2015-12-22 20:26:20 +00:00
<para>
Docs: move harfbuzz-ng-vs-old discussion down below the TOC; put in note.
2018-10-11 20:40:08 +00:00
The canonical source-code tree is available at
<ulink
url="http://cgit.freedesktop.org/harfbuzz/">cgit.freedesktop.org/harfbuzz</ulink>
and at
<ulink
url="https://github.com/harfbuzz/harfbuzz">github.com/harfbuzz/harfbuzz</ulink>.
Move more docs from FreeDesktop page
2015-12-22 21:29:48 +00:00
See <xref linkend="download" endterm="download.title"/> for release tarballs.
Intro from freedesktop.org/wiki/Software/HarfBuzz/
2015-12-22 20:26:20 +00:00
</abstract>
[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
</bookinfo>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<part>
<title>User's manual</title>
Rename user manual files Use chapter ids instead of numbers, so that we can reorder them, introduce new ones etc. without the numbers becoming out of date.
2015-12-22 20:33:41 +00:00
<xi:include href="usermanual-what-is-harfbuzz.xml"/>
Move more docs from FreeDesktop page
2015-12-22 21:29:48 +00:00
<xi:include href="usermanual-install-harfbuzz.xml"/>
Rename user manual files Use chapter ids instead of numbers, so that we can reorder them, introduce new ones etc. without the numbers becoming out of date.
2015-12-22 20:33:41 +00:00
<xi:include href="usermanual-hello-harfbuzz.xml"/>
<xi:include href="usermanual-buffers-language-script-and-direction.xml"/>
<xi:include href="usermanual-fonts-and-faces.xml"/>
Added initial usermanual chapter on cluster levels.
2016-01-28 18:14:12 +00:00
<xi:include href="usermanual-clusters.xml"/>
Rename user manual files Use chapter ids instead of numbers, so that we can reorder them, introduce new ones etc. without the numbers becoming out of date.
2015-12-22 20:33:41 +00:00
<xi:include href="usermanual-opentype-features.xml"/>
<xi:include href="usermanual-glyph-information.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
</part>
[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<part>
Move more docs from FreeDesktop page
2015-12-22 21:29:48 +00:00
<partinfo>
<releaseinfo>
This document is for HarfBuzz &version;.
<!--The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://[SERVER]/libharfbuzz/index.html">http://[SERVER]/libharfbuzz/</ulink>.-->
</releaseinfo>
</partinfo>
Docs: move harfbuzz-ng-vs-old discussion down below the TOC; put in note.
2018-10-11 20:40:08 +00:00
<note>
<para>
The current HarfBuzz codebase is versioned 1.x.x and is stable
and under active maintenance. This is what is used in latest
versions of Firefox, GNOME, ChromeOS, Chrome, LibreOffice,
XeTeX, Android, and KDE, among other places.
</para>
<para>
Prior to 2012, the original HarfBuzz codebase (which, these
days, is referred to as <emphasis>harfbuzz-old</emphasis>) was
derived from code in <ulink
url="http://freetype.org/">FreeType</ulink>, <ulink
url="http://pango.org/">Pango</ulink>, and
<ulink url="http://qt-project.org/">Qt</ulink>.
It is <emphasis>not</emphasis> actively developed or
maintained, and is extremely buggy. All users of harfbuzz-old
are encouraged to switch over to the new HarfBuzz as soon as possible.
</para>
<para>
To make this distinction clearer in discussions, the current
HarfBuzz codebase is sometimes referred to as
<emphasis>harfbuzz-ng</emphasis>.
</para>
<para>
For reference purposes, the harfbuzz-old source tree is archived
<ulink
url="http://cgit.freedesktop.org/harfbuzz.old/">here</ulink>. There
are no release tarballs of harfbuzz-old whatsoever.
</para>
</note>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<title>Reference manual</title>
<chapter>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<title>Core API</title>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-blob.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<xi:include href="xml/hb-buffer.xml"/>
<xi:include href="xml/hb-common.xml"/>
<xi:include href="xml/hb-deprecated.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-face.xml"/>
<xi:include href="xml/hb-font.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<xi:include href="xml/hb-map.xml"/>
<xi:include href="xml/hb-set.xml"/>
<xi:include href="xml/hb-shape-plan.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-shape.xml"/>
[docs] Fill in some sections
2018-10-27 11:07:33 +00:00
<xi:include href="xml/hb-unicode.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-version.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
</chapter>
[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<chapter>
<title>OpenType API</title>
<xi:include href="xml/hb-ot-color.xml"/>
[name] Make hb_name_id_t be the enum This is like hb_script_t. We had this exposed as unsigned int since 2.0.0 release in two APIs, as well as hb_ot_layout_get_size_params() from earlier. But since no one uses those (right?!), let's just fix this now.
2018-10-27 09:55:52 +00:00
<xi:include href="xml/hb-ot-font.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-ot-layout.xml"/>
Update docs
2016-09-27 14:42:25 +00:00
<xi:include href="xml/hb-ot-math.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<xi:include href="xml/hb-ot-name.xml"/>
[name] Make hb_name_id_t be the enum This is like hb_script_t. We had this exposed as unsigned int since 2.0.0 release in two APIs, as well as hb_ot_layout_get_size_params() from earlier. But since no one uses those (right?!), let's just fix this now.
2018-10-27 09:55:52 +00:00
<xi:include href="xml/hb-ot-shape.xml"/>
[docs] Hook up hb-var
2018-10-27 12:00:42 +00:00
<xi:include href="xml/hb-ot-var.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
</chapter>
[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<chapter>
<title>Integration API</title>
<xi:include href="xml/hb-coretext.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-ft.xml"/>
[docs] Fill in some sections
2018-10-27 11:07:33 +00:00
<xi:include href="xml/hb-glib.xml"/>
<xi:include href="xml/hb-gobject.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-graphite2.xml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<xi:include href="xml/hb-icu.xml"/>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/hb-uniscribe.xml"/>
</chapter>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<!--chapter id="object-tree">
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
</chapter-->
<index id="api-index-full"><title>API Index</title><xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include></index>
<index id="deprecated-api-index" role="deprecated"><title>Index of deprecated API</title><xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include></index>
[docs] Hook up new symbols
2018-10-27 05:09:17 +00:00
[docs] Divide reference API into three chapters
2018-10-27 12:07:54 +00:00
<index id="api-index-2-0-0" role="2.0.0"><title>Index of new symbols in 2.0.0</title><xi:include href="xml/api-index-2.0.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-9-0" role="1.9.0"><title>Index of new symbols in 1.9.0</title><xi:include href="xml/api-index-1.9.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-8-6" role="1.8.6"><title>Index of new symbols in 1.8.6</title><xi:include href="xml/api-index-1.8.6.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-8-5" role="1.8.5"><title>Index of new symbols in 1.8.5</title><xi:include href="xml/api-index-1.8.5.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-8-1" role="1.8.1"><title>Index of new symbols in 1.8.1</title><xi:include href="xml/api-index-1.8.1.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-8-0" role="1.8.0"><title>Index of new symbols in 1.8.0</title><xi:include href="xml/api-index-1.8.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-7-7" role="1.7.7"><title>Index of new symbols in 1.7.7</title><xi:include href="xml/api-index-1.7.7.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-7-5" role="1.7.5"><title>Index of new symbols in 1.7.5</title><xi:include href="xml/api-index-1.7.5.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-6-0" role="1.6.0"><title>Index of new symbols in 1.6.0</title><xi:include href="xml/api-index-1.6.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-5-0" role="1.5.0"><title>Index of new symbols in 1.5.0</title><xi:include href="xml/api-index-1.5.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-4-3" role="1.4.3"><title>Index of new symbols in 1.4.3</title><xi:include href="xml/api-index-1.4.3.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-4-2" role="1.4.2"><title>Index of new symbols in 1.4.2</title><xi:include href="xml/api-index-1.4.2.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-4-0" role="1.4.0"><title>Index of new symbols in 1.4.0</title><xi:include href="xml/api-index-1.4.0.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-3-3" role="1.3.3"><title>Index of new symbols in 1.3.3</title><xi:include href="xml/api-index-1.3.3.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-2-3" role="1.2.3"><title>Index of new symbols in 1.2.3</title><xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-1-3" role="1.1.3"><title>Index of new symbols in 1.1.3</title><xi:include href="xml/api-index-1.1.3.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-1-2" role="1.1.2"><title>Index of new symbols in 1.1.2</title><xi:include href="xml/api-index-1.1.2.xml"><xi:fallback /></xi:include></index>
<index id="api-index-1-0-5" role="1.0.5"><title>Index of new symbols in 1.0.5</title><xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-42" role="0.9.42"><title>Index of new symbols in 0.9.42</title><xi:include href="xml/api-index-0.9.42.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-41" role="0.9.41"><title>Index of new symbols in 0.9.41</title><xi:include href="xml/api-index-0.9.41.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-39" role="0.9.39"><title>Index of new symbols in 0.9.39</title><xi:include href="xml/api-index-0.9.39.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-38" role="0.9.38"><title>Index of new symbols in 0.9.38</title><xi:include href="xml/api-index-0.9.38.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-31" role="0.9.31"><title>Index of new symbols in 0.9.31</title><xi:include href="xml/api-index-0.9.31.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-30" role="0.9.30"><title>Index of new symbols in 0.9.30</title><xi:include href="xml/api-index-0.9.30.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-28" role="0.9.28"><title>Index of new symbols in 0.9.28</title><xi:include href="xml/api-index-0.9.28.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-22" role="0.9.22"><title>Index of new symbols in 0.9.22</title><xi:include href="xml/api-index-0.9.22.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-20" role="0.9.20"><title>Index of new symbols in 0.9.20</title><xi:include href="xml/api-index-0.9.20.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-11" role="0.9.11"><title>Index of new symbols in 0.9.11</title><xi:include href="xml/api-index-0.9.11.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-10" role="0.9.10"><title>Index of new symbols in 0.9.10</title><xi:include href="xml/api-index-0.9.10.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-8" role="0.9.8"><title>Index of new symbols in 0.9.8</title><xi:include href="xml/api-index-0.9.8.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-7" role="0.9.7"><title>Index of new symbols in 0.9.7</title><xi:include href="xml/api-index-0.9.7.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-5" role="0.9.5"><title>Index of new symbols in 0.9.5</title><xi:include href="xml/api-index-0.9.5.xml"><xi:fallback /></xi:include></index>
<index id="api-index-0-9-2" role="0.9.2"><title>Index of new symbols in 0.9.2</title><xi:include href="xml/api-index-0.9.2.xml"><xi:fallback /></xi:include></index>
Combine user / reference information into gtk-doc generated manual.
2015-08-31 09:40:17 +00:00
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</part>
[gtk-doc] Initial setup Initial setup of gtk-doc. Straight forward setup following the gtk-doc instructions. Ignore some troublesome types in src/hb-gobject.h. To build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in harfbuzz/docs/reference/html/index.html.
2013-02-24 18:00:33 +00:00
</book>
Reference in New Issue Copy Permalink