summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTiago Vignatti <tiago.vignatti@intel.com>2013-04-02 10:08:56 +1000
committerKristian Høgsberg <krh@bitplanet.net>2013-04-03 14:44:55 -0400
commit95bce664f984aee553a2e39f699919ad2e8a2a3c (patch)
tree548f6c84d01356b537151b414e3afa9061fde7a9 /doc
parentbd63d331b9837b9afeab8432bc145b6829fcd92c (diff)
doc: Add a Foreword and a Preface
In particular, the preface defines the scope of this document we're building -- is the definition there enough with respect to what we want with this? Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/Wayland/Makefile.am2
-rw-r--r--doc/Wayland/en_US/Foreword.xml29
-rw-r--r--doc/Wayland/en_US/Preface.xml20
-rw-r--r--doc/Wayland/en_US/Wayland.xml2
4 files changed, 53 insertions, 0 deletions
diff --git a/doc/Wayland/Makefile.am b/doc/Wayland/Makefile.am
index a7e1b54..b56fb60 100644
--- a/doc/Wayland/Makefile.am
+++ b/doc/Wayland/Makefile.am
@@ -3,6 +3,8 @@ publican_sources = \
$(srcdir)/en_US/Architecture.xml \
$(srcdir)/en_US/Author_Group.xml \
$(srcdir)/en_US/Book_Info.xml \
+ $(srcdir)/en_US/Foreword.xml \
+ $(srcdir)/en_US/Preface.xml \
$(srcdir)/en_US/Wayland.xml \
$(srcdir)/en_US/Protocol.xml \
$(srcdir)/en_US/Library.xml \
diff --git a/doc/Wayland/en_US/Foreword.xml b/doc/Wayland/en_US/Foreword.xml
new file mode 100644
index 0000000..eeb16cc
--- /dev/null
+++ b/doc/Wayland/en_US/Foreword.xml
@@ -0,0 +1,29 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
+%BOOK_ENTITIES;
+]>
+
+<preface>
+ <title>Preface</title>
+
+ <para>
+ This document concerns the (i) Wayland architecture, (ii) Wayland model of
+ operation and (iii) its library API. Wayland protocol specification is shown
+ also in the Appendix. The document here is aimed at Wayland developers and
+ who is looking for information how to program with it, but it is not meant
+ primarily for applications developers.
+ </para>
+ <para>
+ There have been many contributors to this document and, while this is the
+ first edition only, many errors are expected to be found. We appreciate
+ corrections.
+ </para>
+ <literallayout>
+Yours,
+
+ the Wayland open-source community
+ November 2012
+ </literallayout>
+</preface>
diff --git a/doc/Wayland/en_US/Preface.xml b/doc/Wayland/en_US/Preface.xml
new file mode 100644
index 0000000..61720a9
--- /dev/null
+++ b/doc/Wayland/en_US/Preface.xml
@@ -0,0 +1,20 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
+%BOOK_ENTITIES;
+]>
+
+<preface>
+ <title>Acknowledgments</title>
+
+ <para>
+ TODO: Kristian has to fill up this with one or two paragraphs and a small
+ "thank you": http://en.wikipedia.org/wiki/Preface
+ </para>
+ <literallayout>
+Best,
+
+ Kristian Høgsberg
+ </literallayout>
+</preface>
diff --git a/doc/Wayland/en_US/Wayland.xml b/doc/Wayland/en_US/Wayland.xml
index 44ccc1d..66b6609 100644
--- a/doc/Wayland/en_US/Wayland.xml
+++ b/doc/Wayland/en_US/Wayland.xml
@@ -5,6 +5,8 @@
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foreword.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Compositors.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />