summaryrefslogtreecommitdiff
path: root/specs/fsproto.xml
AgeCommit message (Collapse)Author
2014-01-22spec: Make alignment of columns in Encoding section more consistentAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: use <parameter> markup for elements of requests & repliesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Remove <!- .LP --> comments leftover from nroff migrationAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Make links to data types, requests, events & errorsAlan Coopersmith
Extracted each set of section ids to file and converted to a perl script: next if m{^\d}; # skip over encoding section body lines next if m{^[adfmnpv] }; # skip over encoding section body lines s{<type>ACCESSCONTEXT</type>}{<link linkend="Data_Types:ACCESSCONTEXT">$&</link>}g; [...] s{<type>XFONTINFO</type>}{<link linkend="Data_Types:XFONTINFO">$&</link>}g; s{<type>LISTofACCESSCONTEXT</type>}{<link linkend="Data_Types:ACCESSCONTEXT">$&</link>}g; [...] s{<type>LISTofXFONTINFO</type>}{<link linkend="Data_Types:XFONTINFO">$&</link>}g; s{<function>NoOp</function>}{<link linkend="Requests:NoOp">$&</link>}g; [...] s{<function>CloseFont</function>}{<link linkend="Requests:CloseFont">$&</link>}g; s{<errorname>Request</errorname>}{<link linkend="Errors:Request">$&</link>}g; [...] s{<errorname>Extensions</errorname>}{<link linkend="Errors:Extensions">$&</link>}g; s{<function>KeepAlive</function>}{<link linkend="Events:KeepAlive">$&</link>}g; [...] s{<function>Extensions</function>}{<link linkend="Events:Extensions">$&</link>}g; s{<title><link linkend="[^"]+">(.*?)</link></title>}{<title>$1</title>}g; s{<row><entry><link linkend="[^"]+"><type>(.*?)</type></link>}{<row><entry><type>$1</type>}g; s{<row><entry morerows=([\d'"]+)><link linkend="[^"]+"><type>(.*?)</type></link>}{<row><entry morerows=$1><type>$2</type>}g; s{<link linkend="([^"]+)"><emphasis role="bold"><link linkend="\1">(.*?)</link></emphasis></link>}{<link linkend="$1"><emphasis role="bold">$2</emphasis></link>}g; if ($_ =~ m{ id=['"]([^"]+)['"]}) { $sectionid = $1; } s{<link linkend="$sectionid">(.*?)</link>}{$1}g; Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: markup enumerated constant names with <constant>Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: add enumerated constants to indexAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: fixup quote charactersAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: give footnotes ids for more stable linksAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert Data Types section to have a section per type, with tablesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Finish replacing nroff .sp macros with <para> breaksAlan Coopersmith
Mostly just removes the <!-- .sp --> comments where they had already been autoconverted. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: markup data type names with <type>Alan Coopersmith
Automated replacement, followed by manual correction to <structfield> when names refer to fields in given types/structs. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Use <superscript> for exponentsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert a bunch of AccessContext references from <function> to </type>Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Use tables for contents of Requests, Events & ErrorsAlan Coopersmith
Much more consistent layout than previous mix of blockquotes & literallayouts Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Use <personname> markup in AcknowledgementsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: make links from encoding section to definitionsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert Errors chapter to have a section per requestAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert Events chapter to have a section per requestAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert Requests chapter to have a section per requestAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Use <errorname> instead of <function> for error namesAlan Coopersmith
Also markup some uses of errornames that were previously missed. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: fix boundaries of <function> tagsAlan Coopersmith
Conversion from nroff .BR "function" "otherstuff" style markup got confused in a few places. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: add autogenerated indexAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Convert .IN comments to indexterm tagsAlan Coopersmith
Performed with: perl -i -p -e 's{\<\!-- \.IN "([^"]+)" "" "\@DEF\@" --\>}{<indexterm significance="preferred"><primary>$1</primary></indexterm>}' specs/fsproto.xml perl -i -p -e 's{\<\!-- \.IN "([^"]+)" "([^"]+)" "\@DEF\@" --\>}{ <indexterm significance="preferred"><primary>$1</primary><secondary>$2</secondary></indexterm>}' specs/fsproto.xml Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: convert list of license models from itemizedlist to variablelistAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: add <acronym> markupAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: remove some extra quotes from nroff conversionAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Use <figure> markup for figure labelsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: add links to references to other sectionsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: change ids for encoding sections from *_2 to Encoding::*Alan Coopersmith
Easier for cross-reference linking, matches what x11proto uses Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: fixup markup/formatting of the naming syntax sectionAlan Coopersmith
Use <replaceable> <literal> <optional> etc. tags instead of &lt;&gt; "" and [] pairs. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: markup introduction of new terms with <firstterm>Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: convert from article with sections to book with chaptersAlan Coopersmith
Matches most other X.Org specs, and restores our chapter numbering in output Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: fixup bibliography entries (correct authors, link to references)Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: add olinks to X11 protocol & XLFD specsAlan Coopersmith
Also use <citetitle> to markup titles of other specs/docs. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22spec: Replace ASCII => & -> arrows with Unicode ▶ & ◀Alan Coopersmith
Matches formatting used in core X11 & current extension specs This spec previously used => for server to client replies, like the other specs, but also had -> for client responses to server data, so the opposing direction arrows should make this distinction clearer. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-10-021 - fix the capitolization of the ID attriutes to match either theMatt Dew
<title> or <funcdef> string it goes with. 2 - fix any <linkend>'s that were affected by 1. 3 - any <function> in the docs that has an actual funcdef, will become an olink. Signed-off-by: Matt Dew <marcoz@osource.org>
2011-09-20specs: use <copyright> for the first holder in multi licensingGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-19specs: The strandard name is still "X Consortium Standard"Gaetan Nadon
This spec, and libX11 spec, are the only two docs with a different standard name. http://cgit.freedesktop.org/xorg/doc/xorg-docs/commit/specs/FSProtocol ?h=XORG-RELEASE-1&id=0f51a88d2cf4a4d1394c79faa3339e5151e5f682 Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-18specs: fix multi licensed copyright notice and license textGaetan Nadon
For documentation having multiple licenses, the copyright and legalnotice elements sequence cannot instantiated multiple times. The copyright notice and license text are therefore coded inside a legalnotice element. The role attribute on the paragraph is used to allow styling of the copyright notice text which should not be italicized. To view the change in the html format, obtain xorg-sgml-doctools at version 1.10.1 or later and rebuild the html version of the spec. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-17specs: fix author affiliation markupGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12docs: use the &fullrelvers; entity to set X11 release informationGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12docs: remove <productnumber> which is not used by defaultGaetan Nadon
This element is not rendered by default on the title. A template customization is required to display it. X Window System does not have a product number. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-12-16spec: Fix section titles/nestingAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-29fsproto.xml: Convert ASCII art figures to UTF-8 line drawingsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-08-09specs: convert protocol fsproto from xorg-docs to DocBook XMLMatt Dew
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>