From 4f3c02dc14300c0b8e51a55d627c57f73c108f64 Mon Sep 17 00:00:00 2001 From: Sumit Bose Date: Fri, 28 Sep 2018 10:36:19 +0200 Subject: [PATCH 1/7] doc: make sure cross-reference ids are predictable To make sure the cross-reference ids are predictable in the auto-generated DBus documentation as well the xsl and css files form the gtk-doc package are updated as well. --- doc/manual/devhelp2.xsl | 173 ++++++++ doc/manual/gtk-doc.xsl | 436 ++++++++----------- doc/manual/realm.xml | 14 +- doc/manual/realmd-guide-active-directory.xml | 4 +- doc/manual/realmd-guide-ipa.xml | 2 +- doc/manual/realmd-guide-kerberos.xml | 2 +- doc/manual/realmd.conf.xml | 4 +- doc/manual/static/gtk-doc.css | 420 +++++++++++++----- 8 files changed, 688 insertions(+), 367 deletions(-) create mode 100644 doc/manual/devhelp2.xsl diff --git a/doc/manual/devhelp2.xsl b/doc/manual/devhelp2.xsl new file mode 100644 index 0000000..bab6692 --- /dev/null +++ b/doc/manual/devhelp2.xsl @@ -0,0 +1,173 @@ + + + + + + + + + + + + book + + + .devhelp2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + , + + + + + diff --git a/doc/manual/gtk-doc.xsl b/doc/manual/gtk-doc.xsl index 9c0901b..3471e6c 100644 --- a/doc/manual/gtk-doc.xsl +++ b/doc/manual/gtk-doc.xsl @@ -5,20 +5,19 @@ version="1.0"> - + + - - + + + 2 book toc @@ -28,16 +27,17 @@ part toc reference toc + 1 - + @@ -60,6 +60,9 @@ + + + - - - - - - - - - - - - - - - - - - - - <ANCHOR id=" - - " href=" - - - / - - - "> - - - - - - <ONLINE href=" - - "> - + + @@ -387,6 +341,15 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ + + + + + + <xsl:copy-of select="$title"/>: <xsl:apply-templates select="$home" mode="object.title.markup"/> + + + @@ -399,10 +362,10 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
- Generated by GTK-Doc V + Generated by GTK-Doc V - Generated by GTK-Doc + Generated by GTK-Doc @@ -451,21 +414,119 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ + summary = "Navigation header" cellpadding="2" cellspacing="5"> + - + - + - + - + - - + - - - - - - - - - - - - - - - - - - -
@@ -758,32 +678,32 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ - @@ -803,6 +723,21 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ + + + + + + em-dash + + + + + + idx @@ -825,12 +760,12 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ -  |  +   |  -  ] +   ] @@ -861,11 +796,6 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ - - @@ -878,7 +808,7 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/ http://foldoc.org/ - + diff --git a/doc/manual/realm.xml b/doc/manual/realm.xml index 9d9136a..7b73331 100644 --- a/doc/manual/realm.xml +++ b/doc/manual/realm.xml @@ -49,7 +49,7 @@ - + Description realm is a command line tool that can be used to manage enrollment in kerberos realms, like Active @@ -81,7 +81,7 @@ - + Discover Discover a realm and its capabilities. @@ -138,7 +138,7 @@ $ realm discover domain.example.com - + Join Configure the local machine for use with a realm. @@ -263,7 +263,7 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com - + Leave Deconfigure the local machine for use with a realm. @@ -313,7 +313,7 @@ $ realm leave domain.example.com - + List List all the discovered and configured realms. @@ -345,7 +345,7 @@ $ realm list - + Permit Permit local login by users of the realm. @@ -392,7 +392,7 @@ $ realm permit --withdraw user@example.com - + Deny Deny local login by realm accounts. diff --git a/doc/manual/realmd-guide-active-directory.xml b/doc/manual/realmd-guide-active-directory.xml index 362cf94..c88e8af 100644 --- a/doc/manual/realmd-guide-active-directory.xml +++ b/doc/manual/realmd-guide-active-directory.xml @@ -69,7 +69,7 @@ $ realm discover --verbose domain.example.com Winbind. By default SSSD is used. -
+
Using SSSD with Active Directory SSSD provides client software for various kerberos and/or LDAP @@ -91,7 +91,7 @@ $ realm join --client-software=sssd domain.example.com
-
+
Using Winbind with Active Directory Samba Winbind diff --git a/doc/manual/realmd-guide-ipa.xml b/doc/manual/realmd-guide-ipa.xml index bba6504..c3ad450 100644 --- a/doc/manual/realmd-guide-ipa.xml +++ b/doc/manual/realmd-guide-ipa.xml @@ -13,7 +13,7 @@ users locally, and log into the local machine with IPA domain credentials. -
+
Discovering IPA domains realmd discovers which domains or realms it can use or configure. It can discover and identify diff --git a/doc/manual/realmd-guide-kerberos.xml b/doc/manual/realmd-guide-kerberos.xml index a57e964..5b9d4b1 100644 --- a/doc/manual/realmd-guide-kerberos.xml +++ b/doc/manual/realmd-guide-kerberos.xml @@ -12,7 +12,7 @@ Since there is no standard way to enroll a computer against a Kerberos server, it is not possible to do this with realmd. -
+
Discovering Kerberos realms realmd discovers which domains or realms it can use or configure. It can discover and identify diff --git a/doc/manual/realmd.conf.xml b/doc/manual/realmd.conf.xml index a2b577c..f0b0879 100644 --- a/doc/manual/realmd.conf.xml +++ b/doc/manual/realmd.conf.xml @@ -28,7 +28,7 @@ Tweak behavior of realmd - + Configuration File realmd can be tweaked by network administrators @@ -297,7 +297,7 @@ DOMAIN\user:*:13445:13446:Name:/home/DOMAIN/user:/bin/bash - + Realm specific settings These options should go in an section with the same name as the realm in the /etc/realmd.conf file. diff --git a/doc/manual/static/gtk-doc.css b/doc/manual/static/gtk-doc.css index 5618926..af6ce9c 100644 --- a/doc/manual/static/gtk-doc.css +++ b/doc/manual/static/gtk-doc.css @@ -1,15 +1,23 @@ +body +{ + font-family: cantarell, sans-serif; +} .synopsis, .classsynopsis { /* tango:aluminium 1/2 */ background: #eeeeec; - border: solid 1px #d3d7cf; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); padding: 0.5em; } .programlisting { /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ background: #e6f3ff; border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0.5em; } .variablelist @@ -22,86 +30,8 @@ vertical-align: top; } -@media screen { - sup a.footnote - { - position: relative; - top: 0em ! important; - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - display: inline-block; - position: relative; - top:-5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 3.2em; - padding-bottom: 20em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - z-index: 10; - } - .navigation a, .navigation a:visited - { - /* tango:scarlet red 3 */ - color: #a40000; - } - .navigation a:hover - { - /* tango:scarlet red 1 */ - color: #ef2929; - } - td.shortcuts - { - /* tango:scarlet red 1 */ - color: #ef2929; - font-size: 80%; - white-space: nowrap; - } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - -.navigation .title -{ - font-size: 200%; +span.nowrap { + white-space: nowrap; } div.gallery-float @@ -131,6 +61,72 @@ a:hover color: #729fcf; } +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + div.table table { border-collapse: collapse; @@ -153,14 +149,44 @@ div.table table th background-color: #d3d7cf; } +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + hr { - /* tango:aluminium 3 */ - color: #babdb6; - background: #babdb6; + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; border: none 0px; height: 1px; clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; } .footer @@ -172,31 +198,70 @@ hr font-size: 80%; } +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + .warning { /* tango:orange 0/1 */ background: #ffeed9; + background: rgba(252, 175, 62, 0.1); border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); } .note { /* tango:chameleon 0/0.5 */ background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); } -.note, .warning +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote { padding: 0.5em; border-width: 1px; border-style: solid; + margin: 2em; } -.note h3, .warning h3 +.note p, .warning p { - margin-top: 0.0em + margin: 0; } -.note p, .warning p + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section { - margin-bottom: 0.0em + margin-bottom: 1em; } /* blob links */ @@ -209,33 +274,52 @@ h2 .extralinks, h3 .extralinks font-weight: normal; } +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + .annotation { /* tango:aluminium 5 */ color: #555753; - font-size: 80%; font-weight: normal; } +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + /* code listings */ -.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ -.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ -.listing_code .programlisting .function { color: #000000; font-weight: bold; } -.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ -.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .normal, +.listing_code .programlisting .normal a, +.listing_code .programlisting .number, +.listing_code .programlisting .cbracket, +.listing_code .programlisting .symbol { color: #555753; } +.listing_code .programlisting .comment, .listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ -.listing_code .programlisting .normal { color: #000000; } -.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .function, +.listing_code .programlisting .function a, .listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ -.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ -.listing_code .programlisting .type { color: #000000; } -.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ -.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ +.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ +.listing_code .programlisting .keyword, +.listing_code .programlisting .usertype, +.listing_code .programlisting .type, +.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ .listing_frame { /* tango:sky blue 1 */ border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0px; } @@ -247,18 +331,152 @@ h2 .extralinks, h3 .extralinks .listing_lines { /* tango:sky blue 0.5 */ background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); /* tango:aluminium 6 */ color: #2e3436; } .listing_code { /* tango:sky blue 0 */ background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); } .listing_code .programlisting { /* override from previous */ border: none 0px; padding: 0px; + background: none; } .listing_lines pre, .listing_code pre { margin: 0px; } + +@media screen { + /* these have a as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} -- 2.25.1
- - -

- - - -

-
- -

- - - - - - - - -

-
-
-

+ + +

+ + + +

+ + +

+ + + + + + + + +

+
+ +

+