Commit graph

30 commits

Author SHA1 Message Date
Alan Coopersmith
9c0be82017 specs/XKB: Trim leading spaces off text lines
perl -i -p -e 's{/\*(\S)}{/* \1}g;' *.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:55:38 -07:00
Alan Coopersmith
ac219bf152 specs/XKB: add some more indexterms by hand
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:06 -07:00
Alan Coopersmith
5c3aa4c69e specs/XKB: fixup various formatting issues in <programlisting>s
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:05 -07:00
Alan Coopersmith
94b5677478 specs/XKB: add some more links by hand
random bits where a link looked handy

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:44 -07:00
Alan Coopersmith
2be0cc0b2a specs/XKB: replace -&gt; with &rarr; when used as arrow, not in C structs
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:57 -07:00
Alan Coopersmith
bf1f3d6f6f specs/XKB: replace =&gt; with &rArr; for double arrows
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00
Alan Coopersmith
ec4075303c specs/XKB: Markup some subtractions with &minus; instead of -
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00
Alan Coopersmith
441a267e46 specs/XKB: make sure all files have DOCTYPEs so standard entities work
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00
Alan Coopersmith
88fd70bee4 specs/XKB: Markup quoted terms as <quote> instead of with ""
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00
Alan Coopersmith
59d688f4c7 specs/XKB: Markup key terms as <firstterm> instead of <emphasis>
Also add <indexterm> entries for most of them, to make their definitions
or introductions easy to find from the index.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:14 -07:00
Alan Coopersmith
6b96259dab specs/XKB: Manual fixup of parameter markup
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:14 -07:00
Alan Coopersmith
c36ee1a4db specs/XKB: Manual fixup of symbol name markup
Handles typos that caused the scripts to miss matches, misnamed masks, etc.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:57 -07:00
Alan Coopersmith
eb1453a0c6 specs/XKB: Manual fixup of function name markup
Handles typos that caused the scripts to miss matches, functions like
malloc & free from other libraries, function name patterns, etc.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:57 -07:00
Alan Coopersmith
cfd4279c9b specs/XKB: Markup structs as <struct{name,field}> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:56 -07:00
Alan Coopersmith
83839e3780 specs/XKB: Markup XKB macros as <symbol> instead of <emphasis>
Performed via:
 perl -n -e 'printf "s{<emphasis>\\s*%s\\s*</emphasis>}{<symbol>%s</symbol>};\n", $1, $1 if m{^#define\s+([^\s\(]*)}' \
  /usr/include/X11/extensions/XK*h /usr/include/X11/XKBlib.h \
  | sort -u > xkb-defines.pl
 perl -i -p -f xkb-defines.pl *.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:56 -07:00
Alan Coopersmith
33bef06568 specs/XKB: Markup NULL as <symbol> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:55 -07:00
Alan Coopersmith
f10aa1e094 specs/XKB: Markup function args as <parameter> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:55 -07:00
Alan Coopersmith
42b2f5388c specs/XKB: manually fixup some more emphasis tagging mismatches
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:55 -07:00
Alan Coopersmith
3b2f47d44a specs/XKB: re-normalize <emphasis> layout in xml files
Same script as before, just with <!-- xref --> comments out of the way
now.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:54 -07:00
Alan Coopersmith
ce95f152ed specs/XKB: Remove remaining xref comments
All the places marked by these have been turned into the appropriate
link, xref, or olink tags now.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:54 -07:00
Alan Coopersmith
087a233847 specs/XKB: Turn Table references into links
Adds id attributes to all table tags so we can link to them

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:53 -07:00
Alan Coopersmith
135fa07b74 specs/XKB: Turn section references into xref links
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:53 -07:00
Alan Coopersmith
53e931d799 specs/XKB: Turn Chapter references into xref links
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:53 -07:00
Alan Coopersmith
b7f00ce5bc specs/XKB: Apply <emphasis> to semantic tag transformations from Xlib spec
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:53 -07:00
Alan Coopersmith
b00a7ddff2 specs/XKB: Markup function names as <function> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:52 -07:00
Alan Coopersmith
bfbb58b767 specs/XKB: normalize <emphasis> layout in xml files
- Stop placing <emphasis> on empty space, commas, and periods.
- Move periods & commas after closing </emphasis> tag
- move <emphasis> open & close tags to same line, instead of mirroring
  nroff layout.

Simplifies automating further transformations of these tags.

Performed via:
 perl -i -0 -p \
    -e 's{<emphasis>(\s*)</emphasis>}{}msg;' \
    -e 's{<emphasis>([\s\.,]*)</emphasis>\s*}{\1}msg;' \
    -e 's{\n([\.,])\s*}{\1\n}msg;' \
    -e 's{([^\.])([\.,])\s*</emphasis>}{\1</emphasis>\2}msg;' \
    -e 's{\s*<emphasis>\n\s*}{\n<emphasis>}msg;' *xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:51 -07:00
Alan Coopersmith
b16ee69a01 specs/XKB: Convert to funcsynopsis+variablelist instead of informaltable
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:16 -07:00
Matt Dew
cadcbd376f informaltable & table cleanup
On certain tables, add top and bottom borders to table header
and a bottom border to the table. This matches what those
tables in the old pdfs looked like.

the <?dbfo keep-together='always'> prevents tables from
splitting across pages. Useful for tiny tables.

Converting the colwidth to a floating point, IE, 1* -> 1.0*
cleans up these build errors:
WARNING: table-layout="fixed" and column-width unspecified =>
falling back to proportional-column-width(1)

Signed-off-by: Matt Dew <marcoz@osource.org>
2012-01-21 17:59:51 -07:00
Matt Dew
22ba43d198 Cleanup IDs and links in doc
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-10-07 22:52:30 -06:00
Matt Dew
8f8a3c8c42 specs: convert XKBlib spec from Framemaker to DocBook.xml
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-11-30 10:52:55 -05:00