From: Didier "Ptitjes Date: Tue, 20 Oct 2009 00:04:26 +0000 (+0200) Subject: Html: Simplify css stylesheets by using descendant selectors X-Git-Tag: 0.37.1~3^2~549 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f08b015441405a1e27593e92d308e31495f488fd;p=thirdparty%2Fvala.git Html: Simplify css stylesheets by using descendant selectors --- diff --git a/src/doclets/htmlhelpers/deps/style.css b/src/doclets/htmlhelpers/deps/style.css index cd25af78b..053bc15e2 100644 --- a/src/doclets/htmlhelpers/deps/style.css +++ b/src/doclets/htmlhelpers/deps/style.css @@ -12,7 +12,6 @@ ul.external_link { .main_diagram { display: block; margin: 0px auto; - width: 50%; } .site_navi { @@ -200,23 +199,7 @@ h3.main_title { - -.main_inline_navigation_virtual_property { - list-style-image: url(virtualproperty.png); -} -.main_inline_navigation_abstract_property { - list-style-image: url(abstractproperty.png); -} -.navi_abstract_prop { - list-style-image: url(abstractproperty.png); -} -.navi_virtual_prop { - list-style-image: url(virtualproperty.png); -} - - - -.css_content_link_constant { +.description a.constant, .brief_description a.constant { background-image:url(constant.png); display:inline-block; padding-right:17px; @@ -224,7 +207,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_namespace { +.description a.namespace, .brief_description a.namespace { background-image:url(namespace.png); display:inline-block; padding-right:17px; @@ -232,7 +215,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_struct { +.description a.struct, .brief_description a.struct { background-image:url(struct.png); display:inline-block; padding-right:17px; @@ -240,7 +223,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_interface { +.description a.interface, .brief_description a.interface { background-image:url(interface.png); display:inline-block; padding-right:17px; @@ -248,7 +231,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_enum { +.description a.enum, .brief_description a.enum { background-image:url(enum.png); display:inline-block; padding-right:17px; @@ -256,7 +239,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_errordomain { +.description a.errordomain, .brief_description a.errordomain { background-image:url(errordomain.png); display:inline-block; padding-right:17px; @@ -264,7 +247,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_delegate { +.description a.delegate, .brief_description a.delegate { background-image:url(delegate.png); display:inline-block; padding-right:17px; @@ -272,7 +255,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_signal { +.description a.signal, .brief_description a.signal { background-image:url(signal.png); display:inline-block; padding-right:17px; @@ -280,7 +263,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_field { +.description a.field, .brief_description a.field { background-image:url(field.png); display:inline-block; padding-right:17px; @@ -288,7 +271,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_enumvalue { +.description a.enumvalue, .brief_description a.enumvalue { background-image:url(enumvalue.png); display:inline-block; padding-right:17px; @@ -296,7 +279,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_errorcode { +.description a.errorcode, .brief_description a.errorcode { background-image:url(errorcode.png); display:inline-block; padding-right:17px; @@ -304,7 +287,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_class { +.description a.class, .brief_description a.class { background-image:url(class.png); display:inline-block; padding-right:17px; @@ -312,15 +295,16 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_abstract_class { +.description a.abstract_class, .brief_description a.abstract_class { background-image:url(abstractclass.png); display:inline-block; padding-right:17px; background-repeat:no-repeat; background-position:center right; border:0px; + font-style: italic; } -.css_content_link_property { +.description a.property, .brief_description a.property { background-image:url(property.png); display:inline-block; padding-right:17px; @@ -328,7 +312,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_virtual_property { +.description a.virtual_property, .brief_description a.virtual_property { background-image:url(virtualproperty.png); display:inline-block; padding-right:17px; @@ -336,7 +320,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_abstract_property { +.description a.abstract_property, .brief_description a.abstract_property { background-image:url(abstractproperty.png); display:inline-block; padding-right:17px; @@ -344,7 +328,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_method { +.description a.method, .brief_description a.method { background-image:url(method.png); display:inline-block; padding-right:17px; @@ -352,7 +336,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_static_method { +.description a.static_method, .brief_description a.static_method { background-image:url(staticmethod.png); display:inline-block; padding-right:17px; @@ -360,7 +344,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_virtual_method { +.description a.virtual_method, .brief_description a.virtual_method { background-image:url(virtualmethod.png); display:inline-block; padding-right:17px; @@ -368,7 +352,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_abstract_method { +.description a.abstract_method, .brief_description a.abstract_method { background-image:url(abstractmethod.png); display:inline-block; padding-right:17px; @@ -376,7 +360,7 @@ h3.main_title { background-position:center right; border:0px; } -.css_content_link_construction_method { +.description a.creation_method, .brief_description a.creation_method { background-image:url(constructor.png); display:inline-block; padding-right:17px; @@ -385,78 +369,73 @@ h3.main_title { border:0px; } -.main_inline_navigation_virtual_method { - list-style-image:url(virtualmethod.png); -} -.main_inline_navigation_errorcode { +.navi_main .errorcode, .navi_inline .errorcode { list-style-image:url(errorcode.png); } -.main_inline_navigation_enumvalue { +.navi_main .enumvalue, .navi_inline .enumvalue { list-style-image:url(enumvalue.png); } -.navi_abstract_class, .main_inline_navigation_abstract_class { +.navi_main .abstract_class, .navi_inline .abstract_class { list-style-image: url(abstractclass.png); } -.main_inline_navigation_abstract_method, .navi_abstract_method { +.navi_main .abstract_method, .navi_inline .abstract_method { list-style-image: url( abstractmethod.png ); } -.navi_construction_method, .main_list_m, .main_inline_navigation_construction_method { +.navi_main .construction_method, .navi_inline .construction_method, .main_list_m { list-style-image: url(constructor.png); } -.navi_static_method, .main_inline_navigation_static_method { +.navi_main .static_method, .navi_inline .static_method { list-style-image: url(staticmethod.png); } - -.navi_package_index, .main_inline_navigation_package { +.navi_main .package_index { list-style-image: url(packages.png); } -.navi_virtual_method { +.navi_main .virtual_method, .navi_inline .virtual_method { list-style-image: url(virtualmethod.png); } -.main_navi_enval { - list-style-image: url(enumvalue.png); -} -.main_navi_errdomcode { - list-style-image: url(errorcode.png); -} -.navi_error_domain, .main_list_errdom, .main_inline_navigation_errordomain { +.navi_main .errordomain, .navi_inline .errordomain, .main_list_errdom { list-style-image: url(errordomain.png); } -.navi_namespace, .main_list_ns, .main_inline_navigation_namespace { +.navi_main .namespace, .navi_inline .namespace, .main_list_ns { list-style-image: url(namespace.png); } -.navi_method, .main_inline_navigation_method { +.navi_main .method, .navi_inline .method { list-style-image: url(method.png); } -.navi_struct, .main_list_stru, .main_inline_navigation_struct { +.navi_main .struct, .navi_inline .struct, .main_list_stru { list-style-image: url(struct.png); } -.navi_iface, .main_navigation_interface, .main_list_iface { +.navi_main .interface, .navi_inline .interface, .main_list_iface { list-style-image: url(interface.png); } -.navi_field, .main_inline_navigation_fields, .main_list_field { +.navi_main .field, .navi_inline .field, .main_list_field { list-style-image: url(field.png); } -.navi_class, .main_inline_navigation_class, .main_list_cl { +.navi_main .class, .navi_inline .class, .main_list_cl { list-style-image: url(class.png); } -.navi_enum, .main_list_en, .main_inline_navigation_enum { +.navi_main .enum, .navi_inline .enum, .main_list_en { list-style-image: url(enum.png); } -.navi_prop, .main_inline_navigation_property, .main_list_prop { +.navi_main .property, .navi_inline .property, .main_list_prop { list-style-image: url(property.png); } -.navi_del, .main_list_del, .main_inline_navigation_delegate { +.navi_main .abstract_property, .navi_inline .abstract_property { + list-style-image: url(abstractproperty.png); +} +.navi_main .virtual_property, .navi_inline .virtual_property { + list-style-image: url(virtualproperty.png); +} +.navi_main .delegate, .navi_inline .delegate, .main_list_del { list-style-image: url(delegate.png); } -.navi_sig, .main_inline_navigation_signal, .main_list_sig { +.navi_main .signal, .navi_inline .signal, .main_list_sig { list-style-image: url(signal.png); } -.navi_package, .main_inline_navigation_package { +.navi_main .package, .navi_inline .package { list-style-image: url(package.png); } - -.main_inline_navigation_constant, .navi_constant { +.navi_main .constant, .navi_inline .constant { list-style-image: url(constant.png); } @@ -480,12 +459,17 @@ h3.main_title { - -a.navi_link, a.external_link { +.navi_main a, .navi_inline a, +a.external_link +{ text-decoration: none; color: #214b87; } +.navi_main .abstract_class > a, .navi_inline .abstract_class > a { + font-style: italic; +} + a.navi_link:hover, a.external_link:hover { text-decoration: underline; } @@ -496,7 +480,7 @@ a.navi_link:hover, a.external_link:hover { .main_see_list { } -.main_inline_navigation { +.navi_inline { } .css_content_literal { diff --git a/src/doclets/htmlhelpers/doclet/doclet.vala b/src/doclets/htmlhelpers/doclet/doclet.vala index 0548fe035..4214c0220 100755 --- a/src/doclets/htmlhelpers/doclet/doclet.vala +++ b/src/doclets/htmlhelpers/doclet/doclet.vala @@ -21,6 +21,7 @@ using GLib; using Valadoc.Content; using Valadoc.Api; + public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected Settings settings; protected HtmlRenderer _renderer; @@ -40,23 +41,14 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_entry_html_template_with_link (string style, string link, string content) { writer.start_tag ("li", style); - writer.link (css_navi_link, link, content); + writer.link (link, content); writer.end_tag ("li"); } protected void write_navi_entry (Api.Node element, Api.Node? pos, string style, bool link, bool full_name = false) { string name; - if (element is Class) { - if (((Class)element).is_abstract) - name = "" + element.name + ""; - else - name = element.name; - } - else if (element is Package) { - name = element.package.name; - } - else if (full_name == true && element is Namespace) { + if (full_name == true && element is Namespace) { string tmp = element.full_name(); name = (tmp == null)? "Global Namespace" : tmp; } @@ -107,20 +99,20 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { string style = null; if (element is Namespace) - style = css_navi_namespace; + style = css_namespace; else if (element is Enum) - style = css_navi_enum; + style = css_enum; else if (element is ErrorDomain) - style = css_navi_error_domain; + style = css_errordomain; else if (element is Struct) - style = css_navi_struct; + style = css_struct; else if (element is Class) - style = (((Class)element).is_abstract)? css_navi_abstract_class : css_navi_class; + style = (((Class)element).is_abstract)? css_abstract_class : css_class; else if (element is Interface) - style = css_navi_iface; + style = css_interface; else if (element is Package) { name = element.package.name; - style = css_navi_package; + style = css_package; } writer.start_tag ("ul", css_navi); @@ -136,8 +128,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_top_element_template (string link) { writer.start_tag ("ul", css_navi); - writer.start_tag ("li", css_navi_package_index); - writer.link (css_navi_link, link, "Packages"); + writer.start_tag ("li", css_package_index); + writer.link (link, "Packages"); writer.end_tag ("li"); writer.end_tag ("ul"); writer.simple_tag ("hr", css_navi_hr); @@ -196,7 +188,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { if (ns.name == null) globals = ns; else - this.write_navi_entry (ns, pos, css_navi_namespace, true, true); + this.write_navi_entry (ns, pos, css_namespace, true, true); } if (globals != null) { @@ -279,7 +271,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("ul", css_navi); foreach (Api.EnumValue env in enum_values) { - this.write_navi_entry (env, en, css_navi_enval, true); + this.write_navi_entry (env, en, css_enumvalue, true); } this.write_navi_child_static_methods (en, parent); @@ -299,7 +291,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("ul", css_navi); foreach (ErrorCode ec in error_codes) { - this.write_navi_entry (ec, errdom, css_navi_errdomcode, true); + this.write_navi_entry (ec, errdom, css_errorcode, true); } this.write_navi_child_static_methods (errdom, parent); @@ -473,11 +465,11 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { if (!m.is_static) { string css; if (m.is_virtual || m.is_override) - css = css_navi_virtual_method; + css = css_virtual_method; else if (m.is_abstract) - css = css_navi_abstract_method; + css = css_abstract_method; else - css = css_navi_method; + css = css_method; if (m == parent) this.write_navi_entry (m, parent, css, false); @@ -490,9 +482,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_construction_methods_collection (Gee.Collection methods, Api.Node? parent) { foreach (Method m in methods) { if (m == parent) - this.write_navi_entry (m, parent, css_navi_construction_method, false); + this.write_navi_entry (m, parent, css_creation_method, false); else - this.write_navi_entry (m, parent, css_navi_construction_method, true); + this.write_navi_entry (m, parent, css_creation_method, true); } } @@ -500,9 +492,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { foreach (Method m in methods) { if (m.is_static) { if (m == parent) - this.write_navi_entry (m, parent, css_navi_static_method, false); + this.write_navi_entry (m, parent, css_static_method, false); else - this.write_navi_entry (m, parent, css_navi_static_method, true); + this.write_navi_entry (m, parent, css_static_method, true); } } } @@ -520,9 +512,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_classes_without_childs_collection (Gee.Collection classes, Api.Node? parent) { foreach (Class cl in classes) { if (cl == parent) - this.write_navi_entry (cl, parent, (cl.is_abstract)? css_navi_abstract_class : css_navi_class, false); + this.write_navi_entry (cl, parent, (cl.is_abstract)? css_abstract_class : css_class, false); else - this.write_navi_entry (cl, parent, (cl.is_abstract)? css_navi_abstract_class : css_navi_class, true); + this.write_navi_entry (cl, parent, (cl.is_abstract)? css_abstract_class : css_class, true); } } @@ -541,9 +533,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { foreach (Api.Signal sig in signals) { if (sig == parent) - this.write_navi_entry (sig, parent, css_navi_sig, false); + this.write_navi_entry (sig, parent, css_signal, false); else - this.write_navi_entry (sig, parent, css_navi_sig, true); + this.write_navi_entry (sig, parent, css_signal, true); } } @@ -553,11 +545,11 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { foreach (Property p in properties) { string css; if (p.is_virtual) - css = css_navi_virtual_prop; + css = css_virtual_property; else if (p.is_abstract) - css = css_navi_abstract_prop; + css = css_abstract_property; else - css = css_navi_prop; + css = css_property; if (p == parent) this.write_navi_entry (p, parent, css, false); @@ -569,9 +561,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_fields_collection (Gee.Collection fields, Api.Node? parent) { foreach (Field f in fields) { if (f == parent) - this.write_navi_entry (f, parent, css_navi_field, false); + this.write_navi_entry (f, parent, css_field, false); else - this.write_navi_entry (f, parent, css_navi_field, true); + this.write_navi_entry (f, parent, css_field, true); } } @@ -583,9 +575,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_constants_collection (Gee.Collection constants, Api.Node? parent) { foreach (Constant c in constants) { if (c == parent) - this.write_navi_entry (c, parent, css_navi_constant, false); + this.write_navi_entry (c, parent, css_constant, false); else - this.write_navi_entry (c, parent, css_navi_constant, true); + this.write_navi_entry (c, parent, css_constant, true); } } @@ -597,9 +589,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_structs_without_childs_collection (Gee.Collection structs, Api.Node? parent) { foreach (Struct stru in structs) { if (stru == parent) - this.write_navi_entry (stru, parent, css_navi_struct, false); + this.write_navi_entry (stru, parent, css_struct, false); else - this.write_navi_entry (stru, parent, css_navi_struct, true); + this.write_navi_entry (stru, parent, css_struct, true); } } @@ -611,9 +603,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_delegates_collection (Gee.Collection delegates, Api.Node? parent) { foreach (Delegate del in delegates) { if (del == parent) - this.write_navi_entry (del, parent, css_navi_del, false); + this.write_navi_entry (del, parent, css_delegate, false); else - this.write_navi_entry (del, parent, css_navi_del, true); + this.write_navi_entry (del, parent, css_delegate, true); } } @@ -625,9 +617,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_interfaces_without_childs_collection (Gee.Collection interfaces, Api.Node? parent) { foreach (Interface iface in interfaces) { if (iface == parent) - this.write_navi_entry (iface, parent, css_navi_iface, false); + this.write_navi_entry (iface, parent, css_interface, false); else - this.write_navi_entry (iface, parent, css_navi_iface, true); + this.write_navi_entry (iface, parent, css_interface, true); } } @@ -639,9 +631,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_enums_without_childs_collection (Gee.Collection enums, Api.Node? parent) { foreach (Enum en in enums) { if (en == parent) - this.write_navi_entry (en, parent, css_navi_enum, false); + this.write_navi_entry (en, parent, css_enum, false); else - this.write_navi_entry (en, parent, css_navi_enum, true); + this.write_navi_entry (en, parent, css_enum, true); } } @@ -653,9 +645,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { protected void write_navi_child_error_domains_without_childs_collection (Gee.Collection errordomains, Api.Node? parent) { foreach (ErrorDomain errdom in errordomains) { if (errdom == parent) - this.write_navi_entry (errdom, parent, css_navi_error_domain, false); + this.write_navi_entry (errdom, parent, css_errordomain, false); else - this.write_navi_entry (errdom, parent, css_navi_error_domain, true); + this.write_navi_entry (errdom, parent, css_errordomain, true); } } @@ -671,9 +663,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { continue ; if (ns == parent) - this.write_navi_entry (ns, parent, css_navi_namespace, false); + this.write_navi_entry (ns, parent, css_namespace, false); else - this.write_navi_entry (ns, parent, css_navi_namespace, true); + this.write_navi_entry (ns, parent, css_namespace, true); } } @@ -684,7 +676,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.simple_tag ("br"); writer.start_tag ("b").text ("Package:").end_tag ("b"); - writer.text (package); + writer.text (" ").text (package); } protected void write_namespace_note (Api.Node element) { @@ -697,7 +689,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.simple_tag ("br"); writer.start_tag ("b").text ("Namespace:").end_tag ("b"); - writer.text (ns.full_name()); + writer.text (" ").text (ns.full_name()); } private void write_brief_description (Api.Node element , Api.Node? pos) { @@ -707,7 +699,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { Gee.List description = doctree.content; if (description.size > 0) { - writer.start_tag ("span", css_inline_navigation_brief_description); + writer.start_tag ("span", css_brief_description); writer.text (" - "); _renderer.set_container (pos); @@ -722,8 +714,12 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { if (doctree == null) return ; + writer.start_tag ("div", css_description); + _renderer.set_container (pos); _renderer.render (doctree); + + writer.end_tag ("div"); } private void write_signature (Api.Node element , Api.Node? pos) { @@ -735,13 +731,13 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("ul", css_navi); foreach (Package pkg in tree.get_package_list()) { if (pkg.is_visitor_accessible (settings)) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (pkg)); - writer.link (css_navi_link, get_link (pkg, null), pkg.name); + writer.start_tag ("li", get_html_css_class (pkg)); + writer.link (get_link (pkg, null), pkg.name); // brief description writer.end_tag ("li"); } else { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (pkg)); + writer.start_tag ("li", get_html_css_class (pkg)); writer.text (pkg.name); writer.end_tag ("li"); } @@ -978,8 +974,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("ul", css_inline_navigation); foreach (Namespace ns in nsl) { if (ns.name != null) { - writer.start_tag ("li", css_inline_navigation_namespace); - writer.link (css_navi_link, get_link (ns, parent), ns.name); + writer.start_tag ("li", css_namespace); + writer.link (get_link (ns, parent), ns.name); this.write_brief_description (ns , parent); writer.end_tag ("li"); if (with_childs == true) { @@ -1010,8 +1006,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Methods:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Method m in imethods) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (m)); - writer.link (css_navi_link, get_link (m, parent), m.name); + writer.start_tag ("li", get_html_css_class (m)); + writer.link (get_link (m, parent), m.name); this.write_brief_description (m , parent); writer.end_tag ("li"); } @@ -1029,10 +1025,10 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { foreach (Package p in deps) { string link = this.get_link(p, parent); if (link == null) - writer.start_tag ("li", css_inline_navigation_package, p.name).text (p.name).end_tag ("li"); + writer.start_tag ("li", css_package, p.name).text (p.name).end_tag ("li"); else { - writer.start_tag ("li", css_inline_navigation_package); - writer.link (css_navi_link, get_link (p, parent), p.name); + writer.start_tag ("li", css_package); + writer.link (get_link (p, parent), p.name); writer.end_tag ("li"); } } @@ -1052,8 +1048,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Static Methods:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Method m in static_methods) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (m)); - writer.link (css_navi_link, get_link (m, parent), m.name); + writer.start_tag ("li", get_html_css_class (m)); + writer.link (get_link (m, parent), m.name); this.write_brief_description (m , parent); writer.end_tag ("li"); } @@ -1195,8 +1191,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Constants:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Constant c in constants) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (c)); - writer.link (css_navi_link, get_link (c, parent), c.name); + writer.start_tag ("li", get_html_css_class (c)); + writer.link (get_link (c, parent), c.name); this.write_brief_description (c, parent); writer.end_tag ("li"); } @@ -1210,8 +1206,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Enums:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Enum en in enums) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (en)); - writer.link (css_navi_link, get_link (en, parent), en.name); + writer.start_tag ("li", get_html_css_class (en)); + writer.link (get_link (en, parent), en.name); this.write_brief_description (en, parent); writer.end_tag ("li"); } @@ -1225,8 +1221,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Errordomains:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (ErrorDomain err in errdoms) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (err)); - writer.link (css_navi_link, get_link (err, parent), err.name); + writer.start_tag ("li", get_html_css_class (err)); + writer.link (get_link (err, parent), err.name); this.write_brief_description (err, parent); writer.end_tag ("li"); } @@ -1240,8 +1236,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Construction Methods:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Method m in methods) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (m)); - writer.link (css_navi_link, get_link (m, parent), m.name); + writer.start_tag ("li", get_html_css_class (m)); + writer.link (get_link (m, parent), m.name); this.write_brief_description (m, parent); writer.end_tag ("li"); } @@ -1264,7 +1260,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { } writer.start_tag ("h2", css_title).text ("Object Hierarchy:").end_tag ("h2"); - writer.image (css_diagram, imgpath); + writer.image (imgpath, "Object hierarchy for %s".printf (element.name), css_diagram); } protected void write_child_fields (FieldHandler fh, Api.Node? parent) { @@ -1273,8 +1269,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Fields:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Field f in fields) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class(f)); - writer.link (css_navi_link, get_link (f, parent), f.name); + writer.start_tag ("li", get_html_css_class(f)); + writer.link (get_link (f, parent), f.name); this.write_brief_description (f, parent); writer.end_tag ("li"); } @@ -1288,8 +1284,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Properties:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Property prop in properties) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (prop)); - writer.link (css_navi_link, get_link (prop, parent), prop.name); + writer.start_tag ("li", get_html_css_class (prop)); + writer.link (get_link (prop, parent), prop.name); this.write_brief_description (prop, parent); writer.end_tag ("li"); } @@ -1303,8 +1299,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Api.Signals:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Api.Signal sig in signals) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (sig)); - writer.link (css_navi_link, get_link (sig, parent), sig.name); + writer.start_tag ("li", get_html_css_class (sig)); + writer.link (get_link (sig, parent), sig.name); this.write_brief_description (sig, parent); writer.end_tag ("li"); } @@ -1318,16 +1314,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Classes:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Class subcl in classes) { - string name; - if (subcl.is_abstract) { - name = "" + subcl.name + ""; - } - else { - name = subcl.name; - } - - writer.start_tag ("li", get_html_inline_navigation_link_css_class (subcl)); - writer.link (css_navi_link, get_link (subcl, parent), name); + writer.start_tag ("li", get_html_css_class (subcl)); + writer.link (get_link (subcl, parent), subcl.name); this.write_brief_description (subcl, parent); writer.end_tag ("li"); } @@ -1341,8 +1329,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Interfaces:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Interface iface in ifaces) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (iface)); - writer.link (css_navi_link, get_link (iface, parent), iface.name); + writer.start_tag ("li", get_html_css_class (iface)); + writer.link (get_link (iface, parent), iface.name); this.write_brief_description (iface, parent); writer.end_tag ("li"); } @@ -1356,8 +1344,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Delegates:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Delegate d in delegates) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (d)); - writer.link (css_navi_link, get_link (d, parent), d.name); + writer.start_tag ("li", get_html_css_class (d)); + writer.link (get_link (d, parent), d.name); this.write_brief_description (d, parent); writer.end_tag ("li"); } @@ -1371,8 +1359,8 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.start_tag ("h3", css_title).text ("Structs:").end_tag ("h3"); writer.start_tag ("ul", css_inline_navigation); foreach (Struct stru in structs) { - writer.start_tag ("li", get_html_inline_navigation_link_css_class (stru)); - writer.link (css_navi_link, get_link (stru, parent), stru.name); + writer.start_tag ("li", get_html_css_class (stru)); + writer.link (get_link (stru, parent), stru.name); this.write_brief_description (stru, parent); writer.end_tag ("li"); } @@ -1458,7 +1446,7 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet { writer.simple_tag ("br"); writer.start_tag ("div", "site_foother"); writer.text ("Generated by "); - writer.link ("site_foother", "http://www.valadoc.org/", "Valadoc"); + writer.link ("http://www.valadoc.org/", "Valadoc"); writer.end_tag ("div"); writer.end_tag ("body"); writer.end_tag ("html"); diff --git a/src/doclets/htmlhelpers/doclet/globals.vala b/src/doclets/htmlhelpers/doclet/globals.vala index c455acd0f..24ee3ed30 100755 --- a/src/doclets/htmlhelpers/doclet/globals.vala +++ b/src/doclets/htmlhelpers/doclet/globals.vala @@ -20,57 +20,37 @@ using Valadoc.Api; namespace Valadoc.Html { - public const string css_inline_navigation = "main_inline_navigation"; - public const string css_inline_navigation_errorcode = "main_inline_navigation_errorcode"; - public const string css_inline_navigation_enumvalue = "main_inline_navigation_enumvalue"; - public const string css_inline_navigation_property = "main_inline_navigation_property"; - public const string css_inline_navigation_virtual_property = "main_inline_navigation_virtual_property"; - public const string css_inline_navigation_abstract_property = "main_inline_navigation_abstract_property"; - public const string css_inline_navigation_method = "main_inline_navigation_method"; - public const string css_inline_navigation_static_method = "main_inline_navigation_static_method"; - public const string css_inline_navigation_virtual_method = "main_inline_navigation_virtual_method"; - public const string css_inline_navigation_abstract_method = "main_inline_navigation_abstract_method"; - public const string css_inline_navigation_construction_method = "main_inline_navigation_construction_method"; - public const string css_inline_navigation_brief_description = "main_inline_navigation_brief_description"; - public const string css_inline_navigation_signal = "main_inline_navigation_signal"; - public const string css_inline_navigation_fields = "main_inline_navigation_fields"; - public const string css_inline_navigation_abstract_class = "main_inline_navigation_abstract_class"; - public const string css_inline_navigation_class = "main_inline_navigation_class"; - public const string css_inline_navigation_enum = "main_inline_navigation_enum"; - public const string css_inline_navigation_struct = "main_inline_navigation_struct"; - public const string css_inline_navigation_delegate = "main_inline_navigation_delegate"; - public const string css_inline_navigation_constant = "main_inline_navigation_constant"; - public const string css_inline_navigation_namespace = "main_inline_navigation_namespace"; - public const string css_inline_navigation_package = "main_inline_navigation_package"; - public const string css_inline_navigation_interface = "main_navigation_interface"; - public const string css_inline_navigation_errordomain = "main_inline_navigation_errordomain"; + public const string css_inline_navigation = "navi_inline"; + + public const string css_errorcode = "errorcode"; + public const string css_enumvalue = "enumvalue"; + public const string css_property = "property"; + public const string css_virtual_property = "virtual_property"; + public const string css_abstract_property = "abstract_property"; + public const string css_method = "method"; + public const string css_static_method = "static_method"; + public const string css_virtual_method = "virtual_method"; + public const string css_abstract_method = "abstract_method"; + public const string css_creation_method = "creation_method"; + public const string css_signal = "signal"; + public const string css_field = "field"; + public const string css_abstract_class = "abstract_class"; + public const string css_class = "class"; + public const string css_enum = "enum"; + public const string css_struct = "struct"; + public const string css_delegate = "delegate"; + public const string css_constant = "constant"; + public const string css_namespace = "namespace"; + public const string css_package = "package"; + public const string css_interface = "interface"; + public const string css_errordomain = "errordomain"; + + public const string css_package_index = "package_index"; + public const string css_brief_description = "brief_description"; + public const string css_description = "description"; + public const string css_site_header = "site_header"; - public const string css_navi_package_index = "navi_package_index"; - public const string css_navi_package = "navi_package"; - public const string css_navi_creation_method = "navi_creation_method"; - public const string css_navi_error_domain = "navi_error_domain"; - public const string css_navi_namespace = "navi_namespace"; - public const string css_navi_abstract_method = "navi_abstract_method"; - public const string css_navi_virtual_method = "navi_virtual_method"; - public const string css_navi_static_method = "navi_static_method"; - public const string css_navi_construction_method = "navi_construction_method"; - public const string css_navi_method = "navi_method"; - public const string css_navi_struct = "navi_struct"; - public const string css_navi_iface = "navi_iface"; - public const string css_navi_field = "navi_field"; - public const string css_navi_class = "navi_class"; - public const string css_navi_abstract_class = "navi_abstract_class"; - public const string css_navi_enum = "navi_enum"; - public const string css_navi_link = "navi_link"; - public const string css_navi_constant = "navi_constant"; - public const string css_navi_prop = "navi_prop"; - public const string css_navi_abstract_prop = "navi_abstract_prop"; - public const string css_navi_virtual_prop = "navi_virtual_prop"; - public const string css_navi_del = "navi_del"; - public const string css_navi_sig = "navi_sig"; public const string css_navi = "navi_main"; - public const string css_navi_enval = "main_navi_enval"; - public const string css_navi_errdomcode = "main_navi_errdomcode"; public const string css_navi_hr = "navi_hr"; public const string css_errordomain_table_name = "main_errordomain_table_name"; public const string css_errordomain_table_text = "main_errordomain_table_text"; @@ -109,28 +89,6 @@ namespace Valadoc.Html { public const string css_style_navigation = "site_navigation"; public const string css_style_content = "site_content"; public const string css_style_body = "site_body"; - public const string css_content_link_constant = "css_content_link_constant"; - public const string css_content_link_namespace = "css_content_link_namespace"; - public const string css_content_link_struct = "css_content_link_struct"; - public const string css_content_link_interface = "css_content_link_interface"; - public const string css_content_link_enum = "css_content_link_enum"; - public const string css_content_link_errordomain = "css_content_link_errordomain"; - public const string css_content_link_delegate = "css_content_link_delegate"; - public const string css_content_link_signal = "css_content_link_signal"; - public const string css_content_link_field = "css_content_link_field"; - public const string css_content_link_enumvalue = "css_content_link_enumvalue"; - public const string css_content_link_errorcode = "css_content_link_errorcode"; - public const string css_content_link_class = "css_content_link_class"; - public const string css_content_link_abstract_class = "css_content_link_abstract_class"; - public const string css_content_link_property = "css_content_link_property"; - public const string css_content_link_virtual_property = "css_content_link_virtual_property"; - public const string css_content_link_abstract_property = "css_content_link_abstract_property"; - public const string css_content_link_method = "css_content_link_method"; - public const string css_content_link_static_method = "css_content_link_static_method"; - public const string css_content_link_virtual_method = "css_content_link_virtual_method"; - public const string css_content_link_abstract_method = "css_content_link_abstract_method"; - public const string css_content_link_construction_method = "css_content_link_construction_method"; - public const string css_content_literal = "css_content_literal"; public delegate string? HtmlLink (Settings settings, Documentation element, Documentation? pos); @@ -160,130 +118,67 @@ namespace Valadoc.Html { return prefix + "/" + ((Api.Node)element).full_name() + ".html" + tmp; } - public string get_html_content_link_css_class ( Valadoc.Api.Item element ) { - if ( element is Namespace ) { - return css_content_link_namespace; - } - else if ( element is Struct ) { - return css_content_link_struct; - } - else if ( element is Interface ) { - return css_content_link_interface; - } - else if ( element is Class ) { - if ( ((Class)element).is_abstract ) - return css_content_link_abstract_class; - else - return css_content_link_class; - } - else if ( element is Enum ) { - return css_content_link_enum; - } - else if ( element is ErrorDomain ) { - return css_content_link_errordomain; - } - else if ( element is Delegate ) { - return css_content_link_delegate; - } - else if ( element is Method ) { - if ( ((Method)element).is_constructor ) - return css_content_link_construction_method; - else if ( ((Method)element).is_abstract ) - return css_content_link_abstract_method; - else if ( ((Method)element).is_override || ((Method)element).is_override ) - return css_content_link_virtual_method; - else if ( ((Method)element).is_static ) - return css_content_link_static_method; - else - return css_content_link_method; - } - else if ( element is Api.Signal ) { - return css_content_link_signal; - } - else if ( element is Property ) { - if ( ((Property)element).is_virtual || ((Property)element).is_override ) - return css_content_link_virtual_property; - else if ( ((Property)element).is_abstract ) - return css_content_link_abstract_property; - else - return css_content_link_property; - } - else if ( element is Field ) { - return css_content_link_field; - } - else if ( element is Constant ) { - return css_content_link_constant; - } - else if ( element is Api.EnumValue ) { - return css_content_link_enumvalue; - } - else if ( element is ErrorCode ) { - return css_content_link_errorcode; - } - return ""; - } - - public string get_html_inline_navigation_link_css_class ( Valadoc.Api.Item element ) { + public string get_html_css_class (Valadoc.Api.Item element) { if ( element is Namespace ) { - return css_inline_navigation_namespace; + return css_namespace; } else if ( element is Struct ) { - return css_inline_navigation_struct; + return css_struct; } else if ( element is Interface ) { - return css_inline_navigation_interface; + return css_interface; } else if ( element is Class ) { - return (((Class)element).is_abstract)? css_inline_navigation_abstract_class : css_inline_navigation_class; + return (((Class)element).is_abstract)? css_abstract_class : css_class; } else if ( element is Enum ) { - return css_inline_navigation_enum; + return css_enum; } else if ( element is ErrorDomain ) { - return css_inline_navigation_errordomain; + return css_errordomain; } else if ( element is Delegate ) { - return css_inline_navigation_delegate; + return css_delegate; } else if ( element is Method ) { if ( ((Method)element).is_static ) - return css_inline_navigation_static_method; + return css_static_method; else if ( ((Method)element).is_static ) - return css_inline_navigation_static_method; + return css_static_method; else if ( ((Method)element).is_constructor ) - return css_inline_navigation_construction_method; + return css_creation_method; else if ( ((Method)element).is_abstract ) - return css_inline_navigation_abstract_method; + return css_abstract_method; else if ( ((Method)element).is_virtual || ((Method)element).is_override ) - return css_inline_navigation_virtual_method; + return css_virtual_method; else - return css_inline_navigation_method; + return css_method; } else if ( element is Api.Signal ) { - return css_inline_navigation_signal; + return css_signal; } else if ( element is Property ) { if ( ((Property)element).is_virtual || ((Property)element).is_override ) - return css_inline_navigation_virtual_property; + return css_virtual_property; else if ( ((Property)element).is_abstract ) - return css_inline_navigation_abstract_property; + return css_abstract_property; else - return css_inline_navigation_property; + return css_property; } else if ( element is Field ) { - return css_inline_navigation_fields; + return css_field; } else if ( element is Constant ) { - return css_inline_navigation_constant; + return css_constant; } else if ( element is Api.EnumValue ) { - return css_inline_navigation_enumvalue; + return css_enumvalue; } else if ( element is ErrorCode ) { - return css_inline_navigation_errorcode; + return css_errorcode; } else if ( element is Package ) { - return css_inline_navigation_package; + return css_package; } return ""; } @@ -291,3 +186,4 @@ namespace Valadoc.Html { + diff --git a/src/doclets/htmlhelpers/doclet/htmlrenderer.vala b/src/doclets/htmlhelpers/doclet/htmlrenderer.vala index 364712499..01ef7c08c 100755 --- a/src/doclets/htmlhelpers/doclet/htmlrenderer.vala +++ b/src/doclets/htmlhelpers/doclet/htmlrenderer.vala @@ -56,7 +56,9 @@ public class Valadoc.Html.HtmlRenderer : ContentRenderer { private void write_symbol_link (Api.Node symbol, string label) { var url = get_url (symbol); - writer.link ("", url, (label == null || label == "") ? symbol.full_name () : label); + writer.link (url, + (label == null || label == "") ? symbol.full_name () : label, + get_html_css_class (symbol)); } private delegate void Write (); @@ -199,7 +201,7 @@ public class Valadoc.Html.HtmlRenderer : ContentRenderer { public override void visit_embedded (Embedded element) { var caption = element.caption; - writer.image ("", element.url, (caption == null || caption == "") ? "" : caption); + writer.image (element.url, (caption == null || caption == "") ? "" : caption); } public override void visit_headline (Headline element) { @@ -210,7 +212,7 @@ public class Valadoc.Html.HtmlRenderer : ContentRenderer { public override void visit_link (Link element) { var label = element.label; - writer.link ("", element.url, (label == null || label == "") ? element.url : label); + writer.link (element.url, (label == null || label == "") ? element.url : label); } public override void visit_symbol_link (SymbolLink element) {