summaryrefslogtreecommitdiff
path: root/specs
AgeCommit message (Collapse)AuthorFilesLines
2024-04-06specs: Fix titles for subsections of Toggle Widget: Convenience RoutinesAlan Coopersmith1-3/+12
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2024-04-06specs: remove function prototypes duplicated as arguments to themselvesAlan Coopersmith1-3/+0
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2024-04-06specs: fix adjacent parameters with the same type in function prototypesAlan Coopersmith6-23/+45
When listing multiple parameters of the same type, the first one was often run together with the type and not shown as a parameter name, and the type name was not shown for the second one (since it had been listed as a K&R style definition but was being displayed as an ANSI/ISO style prototype). Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-05-07Fix spelling/wording issuesAlan Coopersmith2-5/+6
Found by using: codespell --builtin clear,rare,usage,informal,code,names Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-07-04trim some stray backslashes leftover from nroff, and fix some whitespace in ↵Thomas E. Dickey6-83/+83
code samples Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
2019-02-18specs: app-defaults & rgb.txt are in /usr/share now, not /usr/libAlan Coopersmith1-3/+3
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: remove excess spaces between < > and header namesAlan Coopersmith6-15/+15
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: move trailing punctuation to behind </function> tagAlan Coopersmith7-27/+27
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: replace nroff hair space (\^) with Unicode entity (&#x200A;)Alan Coopersmith1-3/+3
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: replace nroff 1/6th-em space (\|) with Unicode entity (&#x2006;)Alan Coopersmith11-55/+55
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: misc. manual fixesAlan Coopersmith5-18/+12
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Convert ``quotes'' to <quote>Alan Coopersmith13-21/+21
perl -i -p -e 's{\`\`(.*?)\x27\x27}{<quote>\1</quote>}' *.xml Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: fixup remaining troff \fI & \fP escapesAlan Coopersmith5-20/+22
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: fixup some more xrefs & linksAlan Coopersmith8-66/+41
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: restore missing list terms in "Underlying Model"Alan Coopersmith1-14/+11
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: use glossary list markup for Terminology sectionAlan Coopersmith1-130/+82
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: show libXaw version instead of X11R7.7Alan Coopersmith2-1/+4
Since we stopped doing katamaris, the library version is needed to tell what release the docs are from. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: update credits for DocBook conversionAlan Coopersmith1-0/+8
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Reorder subsections of CH5 to match X11R6.6 specAlan Coopersmith1-4/+5
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Add missing subsections of CH4 and reorder to match X11R6.6 specAlan Coopersmith3-20/+22
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Add olinks to ICCCM specAlan Coopersmith1-1/+2
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Add olinks to libX11 specAlan Coopersmith2-5/+11
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Add olinks to libXt specAlan Coopersmith5-23/+58
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: Convert troff .IN macros to docbook <indexterm> tagsAlan Coopersmith37-441/+442
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-18specs: suggest XtOpenApplication instead of XtAppInitializeAlan Coopersmith1-20/+37
Fixes https://bugs.freedesktop.org/show_bug.cgi?id=37552 "libXaw.html promotes obsolete XtAppInitialize" Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-10-05Cleanup IDs and links in docMatt Dew39-264/+266
1 - fix the capitalization of the ID attributes to match either the <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-19specs: refactor multi license legal textGaetan Nadon1-16/+15
Also restore lost information. There was no version number for this spec as in many of the docs. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-16Strip trailing whitespaceAlan Coopersmith10-43/+43
Performed with: find * -type f | xargs perl -i -p -e 's{[ \t]+$}{}' git diff -w & git diff -b show no diffs from this change Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-09-13specs: fix orphan author affiliation.Gaetan Nadon1-1/+1
It belongs to Chris Peterson formerly of MIT Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12docs: use the &fullrelvers; entity to set X11 release informationGaetan Nadon1-2/+5
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-11docs: remove <productnumber> which is not used by defaultGaetan Nadon1-1/+0
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>
2011-06-12Install xml versions of specs even if HAVE_XMLTO is falseGaetan Nadon1-2/+0
DocBook/XML input source is also a usefull output format that can be viewed with an XML viewer or editor and by some O/S help system. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-06-04Add id attributes to funcsynopsis to allow other docs to olink to them.Matt Dew15-73/+73
Signed-off-by: Matt Dew <marcoz@osource.org> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2011-05-28Correct path to examples in X11R5 contrib archiveAlan Coopersmith1-1/+1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-27Bug 37536: Documentation refers to invalid contrib/examples/mit/XawAlan Coopersmith1-4/+5
https://bugs.freedesktop.org/show_bug.cgi?id=37536 Update text to point to the latest distributed copy I found, in the X11R5 contrib archives. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-03-30Documentation: add Docbook external references supportGaetan Nadon2-54/+12
When writing technical documentation, it is often necessary to cross reference to other information. When that other information is not in the current document, additional support is needed, namely <olink>. A new feature with version 1.7 of xorg-sgml-doctools adds references to other documents within or outside this package. This patch adds technical support for this feature but does not change the content of the documentation as seen by the end user. Each book or article must generate a database containing the href of sections that can be referred to from another document. This database is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that the value of DATAROOTDIR for xorg-sgml-doctools and for the package documentation is the same. This forms a virtual document tree. This database is consulted by other documents while they are being generated in order to fulfill the missing information for linking. Refer to the xorg-sgml-doctools for further technical information. Co-authored-by: Matt Dew <marcoz@osource.org> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-11-11specs/CH6.xml: Remove stray quote in chapter titleAlan Coopersmith1-1/+1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-09config: HTML file generation: use the installed copy of xorg.cssGaetan Nadon2-7/+2
Currenlty the xorg.css file is copied in each location where a DocBook/XML file resides. This produces about 70 copies in the $(docdir) install tree. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-10-24specs/Makefile.am: remove whitespace after line continuation charsAlan Coopersmith1-2/+2
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-06Purge cvs tags.Jesse Adkins4-10/+0
Signed-off-by: Jesse Adkins <jesserayadkins@gmail.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-07-09specs: use pattern rules rather than suffix rulesGaetan Nadon1-4/+4
This allows target to rebuild when included .xml files are changed. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-07-06specs: libXaw.xml was listed twice in dist_doc_DATAGaetan Nadon1-1/+0
This should fix the dist/install target problem on some tinder boxes Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-07-06specs: remove file accidently checked-inGaetan Nadon1-47/+0
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-07-06specs: replace troff source with docbook-xml sourceMatt Dew49-0/+22078
Placed specs files in the "specs" directory to be consistent with other libraries specs. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>