Commit graph

27 commits

Author SHA1 Message Date
Tiago Vignatti
95bce664f9 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>
2013-04-03 14:44:55 -04:00
Matthias Clasen
3bda215130 docs: Add information about serials and timestamps
Add some information about serials, timestamps and their uses
to the Input section in the protocol overview.
2013-04-01 21:43:47 -04:00
Matthias Clasen
29ddfdd0df docs: Add details about grabs
Mention implicit grabs, (lack of) explicit grabs, and popup
windows.
2013-04-01 20:01:25 -04:00
Matthias Clasen
a4d2b00ae2 docs: Add details about surfaces
Mention some of the characteristic differences to X:
no global positions, no access to foreign windows.
2013-04-01 19:59:48 -04:00
Matthias Clasen
8d0b577310 docs: Consistency fixes
Say 'object ID' throughout.
2013-04-01 17:40:14 -04:00
Matthias Clasen
390e7a7a42 doc: Improve various sections of the documentation 2013-04-01 17:40:14 -04:00
Matthias Clasen
469c386338 docs: Improve the 'Connect time' section
Turn the bullet-point list into complete sentences.
2013-04-01 17:40:14 -04:00
Matthias Clasen
41d44af8c8 docs: Improve the 'Types of Compositors' section
Turn the bullet-point lists into full paragraphs.
2013-04-01 17:40:14 -04:00
Matthias Clasen
c255bab1ed docs: Slight rewording
The Wayland Protocol -> Wayland Protocol Overview, to align
better with the subsequent Wayland Protocol Specification.
2013-04-01 17:40:13 -04:00
Matthias Clasen
49e2d5af76 docs: Reorder some sections
Move the 'Types of Compositors' section right after the Overview,
and move the 'Client API' part after the protocol spec.
2013-04-01 17:40:13 -04:00
Matthias Clasen
dc206a96dc docs: Add a revision history
Publican complains if it can't find this file.
2013-03-28 14:01:12 -04:00
Tiago Vignatti
73d845af94 doc: Fix incorrectly formatted section header
https://bugs.freedesktop.org/show_bug.cgi?id=56719

Reported-by: Petr Gladkikh <PetrGlad@gmail.com>
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-11-12 16:08:40 -02:00
Tiago Vignatti
e2db4cf26f doc: Add auto-generated Wayland Library chapter
For now only Wayland Client API is described on that chapter, which is
extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet
(doxygen-to-publican) on doxygen output so it becomes docbook valid.

Now all we need to do is populate that header while developing in order to
grow a decent documentation. So please use it!

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-15 13:02:04 -04:00
Tiago Vignatti
29c20e2eb6 doc: Remove superfluous 'index'
We're not setting any sort of index. Remove for now.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-15 11:45:57 -04:00
Ander Conselvan de Oliveira
e0680250e6 doc: Update drag and drop section and add info about selections
Replace the outdated section about drag and drop support with a
rewritten section covering the data source/offer mechanism and
wl_data_device, explaining how selection and drag ang drop works.
2012-10-10 22:01:17 -04:00
Tiago Vignatti
b5af60a57b doc: Remove Shared Object Cache section
We don't support anything like that yet.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-09 22:45:45 -04:00
Tiago Vignatti
7fe381861b doc: Auto-generate Protocol/Interfaces section instead
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-09 22:45:43 -04:00
Tiago Vignatti
d3fe28384c doc: Improve Wire Format section
Fixed the wayland socket name and added documentation for fixed format.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-09 22:45:40 -04:00
Christopher Michael
89eddb4245 Fix grammar in the rendering section.
Upon reading some docs, I found a small grammar mistake in the
rendering section. This patch fixes that.
2012-08-13 11:00:28 -04:00
Martin Olsson
fc0c2e04c5 doc: fix some typos in documentation 2012-07-09 18:03:56 -04:00
Kristian Høgsberg
94bb47020a doc: Update docs to refer to wl_seat instead of wl_input_device 2012-05-16 14:25:45 -04:00
Darxus
6d1902b85c Add missing alt attributes in publican docs.
Haven't figured out how to regenerate the html, so it's not tested.
Looks like remaining html errors will be fixed in the next publican
release:  https://bugzilla.redhat.com/show_bug.cgi?id=788576
2012-05-15 11:02:13 -04:00
Peter Hutterer
f68e156b8f doc: consistently indent the xml files by 2 spaces
2 spaces is enough for xml, otherwise we end up with too little room for the
actual text.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:45 -04:00
Peter Hutterer
966e8ec9c0 doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol
The former is the actual specification, the latter notes about the protocol.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:32 -04:00
Peter Hutterer
adf300dc13 doc: remove unused example files
These files were left in as examples, we have real-world examples now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:14 -04:00
Peter Hutterer
3d7f7e2f4a doc: move documentation from the tex file to docbook
And remove the .tex file

Minor changes:
- where the .tex file had some interface descriptions, the docbook source
  now links to the actual protocol. The exception here is the shared object
  cache which is simply a <programlisting> until the protocol spec exists.
- "Implementation" section skipped, this seems in need of an update anyway
  and may be better documented elsewhere (wiki?)

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:04:25 -04:00
Gaetan Nadon
7ee21abef0 publican: support out-of-source tree build
When srcdir!=builddir, there is no way to tell publican that the source
is in srcdir rather than builldir. The workaround is to copy the source
files from srcdir to builddir. To retain the en-US final destination
name, the source directory is renamed to en_US.

Tested-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-04 15:02:43 -05:00