[Checkins] SVN: grok/trunk/doc/ Add a global navigation tabs for
the major doc sections
Kevin Teague
kevin at bud.ca
Fri Jul 4 04:40:28 EDT 2008
Log message for revision 87997:
Add a global navigation tabs for the major doc sections
Changed:
U grok/trunk/doc/.static/grok.css
U grok/trunk/doc/docindex.template
A grok/trunk/doc/layout.html
-=-
Modified: grok/trunk/doc/.static/grok.css
===================================================================
--- grok/trunk/doc/.static/grok.css 2008-07-04 08:28:09 UTC (rev 87996)
+++ grok/trunk/doc/.static/grok.css 2008-07-04 08:40:27 UTC (rev 87997)
@@ -57,40 +57,54 @@
text-decoration: underline;
}
-div.related {
- background-color: #133f52;
- background-color: #999999;
+div.header {
background: #999999 url("top_bg.jpg") repeat-x;
- color: #000;
+ padding: 0.5em 1em 0 1em;
+}
+
+div.header a{
+ color: #520;
+ padding: 0.5em;
+ text-decoration: none;
+}
+
+div.globalnav {
color: #740;
+ border-bottom: 1px solid #aaa;
width: 100%;
- height: 30px;
- line-height: 30px;
- font-size: 90%;
+ font-size: small;
}
-div.related h3 {
+div.globalnav h3 {
display: none;
}
-div.related ul {
- margin: 0;
- padding: 0 0 0 10px;
+#globalnavwrapper {
+ padding: 2px;
+ margin: 0.5em 0 0 0;
+}
+
+div.globalnav ul {
+ margin: 0 0 0 0;
+ padding: 0;
list-style: none;
}
-div.related li {
+div.globalnav li {
display: inline;
+ padding: 2px 0.5em;
+ margin: 0 1px;
+ background-color: #eee;
+ border: 1px solid #999;
}
-div.related li.right {
- float: right;
- margin-right: 5px;
+div.globalnav a {
+ color: #436976;
+ text-decoration: none;
}
-div.related a {
- color: #000;
- color: #520;
+div.globalnav li:hover {
+ background-color: white;
}
/* ::: Table of Contents :::: */
@@ -167,11 +181,10 @@
/* Grok Tutorial style sidebar */
.section div.sidebar {
- font-size: 95%;
margin: 1em 2em;
padding: 0.5em 2em 1em 100px;
- background-color: #f2f2f2;
- border: 1px solid #777;
+ background-color: #fafaf8;
+ border: 1px solid #aaa;
border-top-width: 6px;
background-image: url(grok_club.gif);
background-repeat: no-repeat;
@@ -621,12 +634,24 @@
margin-top: 10px;
}
+.topic ul {
+ margin: 0 0 0.5em 1.5em;
+ padding: 0;
+}
+
+.topic > ul {
+ margin-left: 0;
+}
+
+.simple li {
+ list-style: none;
+}
+
/* Admonitions */
div.admonition {
- margin-top: 10px;
- margin-bottom: 10px;
- padding: 7px;
+ margin: 0.5em 0;
+ padding: 0.5em;
}
div.admonition dt {
@@ -642,10 +667,25 @@
}
div.seealso {
+ padding: 0;
background-color: #ffc;
border: 1px solid #ff6;
}
+div.seealso .first {
+ background-color: #ffa;
+ padding: 0.25em 0.5em;
+ display: block;
+ float: left;
+ margin: 0 0.5em 0 0;
+}
+
+div.seealso .last {
+ padding: 0.25em 0;
+ display: block;
+ margin: 0;
+}
+
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
@@ -688,8 +728,7 @@
}
p.admonition-title {
- margin: 0px 10px 5px 0px;
- font-weight: bold;
+ margin: 0 0.5em 0.5em 0;
display: inline;
}
@@ -761,12 +800,13 @@
}
pre {
- padding: 5px;
+ padding: 1em;
background-color: #fafafa;
color: #333333;
- border: 1px solid #bbb;
+ border: 2px dotted #eee;
border-left: none;
border-right: none;
+ font-size: medium;
}
tt {
@@ -855,7 +895,7 @@
}
div.sidebar,
- div.related,
+ div.globalnav,
div.footer,
div#comments div.new-comment-box,
#top-link {
Modified: grok/trunk/doc/docindex.template
===================================================================
--- grok/trunk/doc/docindex.template 2008-07-04 08:28:09 UTC (rev 87996)
+++ grok/trunk/doc/docindex.template 2008-07-04 08:40:27 UTC (rev 87997)
@@ -1,6 +1,13 @@
-{% extends "defindex.html" %}
-{% block tables %}
+{% extends "layout.html" %}
+{% set title = 'Overview' %}
+{% block body %}
+ <h1>{{ docstitle }}</h1>
+ <p>
+ This is official documentation for Grok {{ release }}.
+ {% if last_updated %}Last modifed on {{ last_updated }}.{% endif %}
+ </p>
+
<p><strong>Sections</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
Added: grok/trunk/doc/layout.html
===================================================================
--- grok/trunk/doc/layout.html (rev 0)
+++ grok/trunk/doc/layout.html 2008-07-04 08:40:27 UTC (rev 87997)
@@ -0,0 +1,187 @@
+{%- block doctype -%}
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+{%- endblock %}
+{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %}
+{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
+{%- macro relbar %}
+ <div class="header">
+ {%- block rootrellink %}
+ <a href="{{ pathto('index') }}">Official Grok Documentation</a> version {{ release }}
+ {%- endblock %}
+ <div class="globalnav">
+ <h3>Navigation</h3>
+ <div id="globalnavwrapper">
+ <ul>
+ <li><a href="{{ pathto("tutorial") }}">Tutorial</a></li>
+ <li><a href="{{ pathto("grok_overview") }}">Developer's Notes</a></li>
+ <li><a href="{{ pathto("reference/index") }}">Reference</a></li>
+ <li><a rel="index" title="Global index" href="{{ pathto('genindex') }}">Index</a></li>
+ <li><a href="{{ pathto("changes") }}">What's Changed</a></li>
+ <li><a href="http://grok.zope.org/documentation/">Grok Community Doucmentation</a></li>
+ {%- block relbaritems %}{% endblock %}
+ </ul>
+ </div>
+ </div>
+ </div>
+{%- endmacro %}
+{%- macro sidebar %}
+ {%- if builder != 'htmlhelp' %}
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ {%- block sidebarlogo %}
+ {%- if logo %}
+ <p class="logo"><img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebartoc %}
+ {%- if display_toc %}
+ <h3>Table Of Contents</h3>
+ {{ toc }}
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebarrel %}
+ {%- if prev %}
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="{{ prev.link|e }}" title="previous chapter">{{ prev.title }}</a></p>
+ {%- endif %}
+ {%- if next %}
+ <h4>Next topic</h4>
+ <p class="topless"><a href="{{ next.link|e }}" title="next chapter">{{ next.title }}</a></p>
+ {%- endif %}
+ {%- endblock %}
+ {%- if sourcename %}
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ {%- if builder == 'web' %}
+ <li><a href="#comments">Comments ({{ comments|length }} so far)</a></li>
+ <li><a href="{{ pathto('@edit/' + sourcename)|e }}">Suggest Change</a></li>
+ <li><a href="{{ pathto('@source/' + sourcename)|e }}">Show Source</a></li>
+ {%- elif builder == 'html' %}
+ <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}">Show Source</a></li>
+ {%- endif %}
+ </ul>
+ {%- endif %}
+ {%- if customsidebar %}
+ {{ rendertemplate(customsidebar) }}
+ {%- endif %}
+ {%- block sidebarsearch %}
+ {%- if pagename != "search" %}
+ <h3>{{ builder == 'web' and 'Keyword' or 'Quick' }} search</h3>
+ <form class="search" action="{{ pathto('search') }}" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ {%- if builder == 'web' %}
+ <p style="font-size: 90%">Enter a module, class or function name.</p>
+ {%- endif %}
+ {%- endif %}
+ {%- endblock %}
+ </div>
+ </div>
+ {%- endif %}
+{%- endmacro -%}
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ {%- if builder != 'htmlhelp' %}
+ {%- set titlesuffix = " — " + docstitle %}
+ {%- endif %}
+ <title>{{ title|striptags }}{{ titlesuffix }}</title>
+ {%- if builder == 'web' %}
+ <link rel="stylesheet" href="{{ pathto('index') }}?do=stylesheet{%
+ if in_admin_panel %}&admin=yes{% endif %}" type="text/css" />
+ {%- for link, type, title in page_links %}
+ <link rel="alternate" type="{{ type|e(true) }}" title="{{ title|e(true) }}" href="{{ link|e(true) }}" />
+ {%- endfor %}
+ {%- else %}
+ <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+ <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
+ {%- endif %}
+ {%- if builder != 'htmlhelp' %}
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '{{ pathto("", 1) }}',
+ VERSION: '{{ release }}',
+ COLLAPSE_MODINDEX: false,
+ };
+ </script>
+ <script type="text/javascript" src="{{ pathto('_static/jquery.js', 1) }}"></script>
+ <script type="text/javascript" src="{{ pathto('_static/interface.js', 1) }}"></script>
+ <script type="text/javascript" src="{{ pathto('_static/doctools.js', 1) }}"></script>
+ {%- if use_opensearch %}
+ <link rel="search" type="application/opensearchdescription+xml"
+ title="Search within {{ docstitle }}"
+ href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+ {%- endif %}
+ {%- if favicon %}
+ <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+ {%- endif %}
+ {%- endif %}
+{%- block rellinks %}
+ {%- if hasdoc('about') %}
+ <link rel="author" title="About these documents" href="{{ pathto('about') }}" />
+ {%- endif %}
+ <link rel="contents" title="Global table of contents" href="{{ pathto('contents') }}" />
+ <link rel="index" title="Global index" href="{{ pathto('genindex') }}" />
+ <link rel="search" title="Search" href="{{ pathto('search') }}" />
+ {%- if hasdoc('copyright') %}
+ <link rel="copyright" title="Copyright" href="{{ pathto('copyright') }}" />
+ {%- endif %}
+ <link rel="top" title="{{ docstitle }}" href="{{ pathto('index') }}" />
+ {%- if parents %}
+ <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />
+ {%- endif %}
+ {%- if next %}
+ <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
+ {%- endif %}
+ {%- if prev %}
+ <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
+ {%- endif %}
+{%- endblock %}
+{%- block extrahead %}{% endblock %}
+ </head>
+ <body>
+
+{%- block relbar1 %}{{ relbar() }}{% endblock %}
+
+{%- block sidebar1 %}{# possible location for sidebar #}{% endblock %}
+
+{%- block document %}
+ <div class="document">
+ <div class="documentwrapper">
+ {%- if builder != 'htmlhelp' %}
+ <div class="bodywrapper">
+ {%- endif %}
+ <div class="body">
+ {% block body %}{% endblock %}
+ </div>
+ {%- if builder != 'htmlhelp' %}
+ </div>
+ {%- endif %}
+ </div>
+{%- endblock %}
+
+{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
+ <div class="clearer"></div>
+ </div>
+
+{%- block footer %}
+ <div class="footer">
+ {%- if hasdoc('copyright') %}
+ © <a href="{{ pathto('copyright') }}">Copyright</a> {{ copyright }}.
+ {%- else %}
+ © Copyright {{ copyright }}.
+ {%- endif %}
+ {%- if last_updated %}
+ Last updated on {{ last_updated }}.
+ {%- endif %}
+ {%- if show_sphinx %}
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+ {%- endif %}
+ </div>
+{%- endblock %}
+ </body>
+</html>
More information about the Checkins
mailing list