Commits

Vlad Riscutia  committed 959060c Draft

Remove context from search page for now. New release notes

  • Participants
  • Parent commits 77ee39e

Comments (0)

Files changed (8)

File blog/2012/07/05/tinkerer_0_4_beta_released.rst

+Tinkerer 0.4 Beta Released
+==========================
+
+What's New
+----------
+
+New HTML5 Themes
+~~~~~~~~~~~~~~~~
+
+* *boilerplate* is a brand new theme based on 
+  `HTML5 Boilerplate <http://html5boilerplate.com>`_
+* *modern5* is a rewrite of the old *modern* theme based on the new 
+  *boilerplate* and including a lot more detail-work
+
+The old themes (*tinkerbase*, *modern* and *minimal*) are still around for
+backwards compatiblity, though future development will happen around
+HTML5-based themes.
+
+New Built-in Extensions
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* An email obfuscator: :ref:`hide_mail`
+* A new ``Read more`` directive - more info under :ref:`posts`
+
+New Sidebard Widgets
+~~~~~~~~~~~~~~~~~~~~
+
+* A *Categories List* widget
+* A *Tag List* widget
+* A *Tag Cloud* widget
+
+Details here: :ref:`sidebar`.
+
+New Translations
+~~~~~~~~~~~~~~~~
+
+* German translation
+* French translation
+* Polish translation
+
+Just update your ``conf.py`` with the following setting::
+
+    language = "de" # or "fr" or "pl"
+
+Acknowledgements
+----------------
+
+Many thanks to everyone who helped out with suggestions, bug reports, patches
+and pull requests and special thanks to the people on the ever-growing 
+`contributors`_ list for their valuable contributions.
+
+.. _contributors: https://bitbucket.org/vladris/tinkerer/raw/tip/CONTRIBUTORS
+
+.. author:: default
+.. categories:: tinkerer
+.. tags:: tinkerer, release
+.. comments::

File blog/doc/more_tinkering.rst

 Theming
 -------
 
-Tinkerer comes with three themes: *modern* - the default theme, *minimal* - a
-minimalist black and white theme and a base *tinkerbase* theme from which the
-others inherit. *Tinkerbase* is not styled, rather it implements the basic
-layout. Due to the inherent differences between documentation and blogs, 
-Sphinx themes are not fully compatible with Tinkerer.
+Tinkerer comes with a base *boilerplate* theme. This is an unstyled theme based
+on HTML5 Boilerplate. Custom themes should inherit from it.
+
+The default Tinkerer theme is *modern5*, which is based on the *boilerplate*.
+
+Before version 0.4, Tinkerer came with other three themes: *modern* - the 
+default theme, *minimal* - a minimalist black and white theme and a base 
+*tinkerbase* theme from which the others inherit. These themes are still 
+available for backwards compatibility though future development will be based
+on the *boilerplate* theme and HTML5.
+
+Due to the inherent differences between documentation and blogs, Sphinx themes 
+are not fully compatible with Tinkerer.
 
 To tinker with the look of your blog, you have two options:
 
 Create your own theme
 ~~~~~~~~~~~~~~~~~~~~~
 
-Tinkerer themes should inherit from the *tinkerbase* theme. For more information 
-on creating themes see 
+Tinkerer themes should inherit from the *boilerplate* theme. For more 
+information on creating themes see 
 `Creating themes <http://sphinx.pocoo.org/theming.html#creating-themes>`_.
 
 Extensions
 enable blogging with Sphinx and the ``tinkerer.ext.disqus`` extension is the 
 Disqus comment handler.
 
+.. _sidebar:
+
 Sidebar
 -------
 
 The ``html_sidebars`` list contains the list of templates to be rendered on the 
-sidebar. Tinkerer includes ``recent.html`` and ``searchbox.html`` by default.
+sidebar. Tinkerer includes ``recent.html`` and ``searchbox.html`` by default. A
+list of categories, a list of tags and a tag cloud are also part of the Tinkerer
+distribution and can be easily added by updating the ``html_sidebars`` setting in
+``conf.py`` to include the corresponding files.
 
 **recent.html** 
 
 
 **searchbox.html**
 
-    This is the Sphinx quicksearch box.    
+    This is the equivalent of the Sphinx quicksearch box.    
+
+**categories.html**
+
+    Displays a list of categories under which posts were filed.
+
+**tags.html**
+
+    Displays a list of tags under which posts were filed.
+
+**tags_cloud.html**
+
+    Tag cloud.
 
 `More information on sidebars <http://sphinx.pocoo.org/config.html#confval-html_sidebars>`_.
 
 Back to :ref:`tinkerer_reference`.
 
+.. _hide_mail:
+
 Hide Email Addresses From Spam Bots
 -----------------------------------
 

File blog/doc/tinkering.rst

     Hello World!
     ============
 
-
-
     .. author:: default
     .. categories:: none
     .. tags:: none
     .. comments::
-    
-    Some text.
-    
-    .. more::
-    
-    More text.
-
+   
 Add content below the title.
 
 **author**
     
 **more**
 
-    This tells Tinkerer to insert an "Read more..." link into the blog post.
-    The "Read more..." link will only be inserted on multi post pages so that
-    the user does not need to scroll three miles to get to the next blog post
-    if he isn't interested in the current one.
+    At any point in your text, you can insert the ``more`` directive::
+
+        Hello World!
+        ============
+
+        Some text.
+
+        .. more::
+
+        More text.
+
+    This tells Tinkerer to insert a "Read more..." link into the blog post.
+    A "Read more..." link will appear on the front page and the text after the
+    directive will be hidden. The full text will be displayed only on the page 
+    of the post.
    
 .. _pages:
     

File blog/master.rst

 .. toctree::
    :maxdepth: 1
 
+   2012/07/05/tinkerer_0_4_beta_released
    2012/02/09/tinkerer_beta_0_3_released
    2011/12/19/tinkerer_0_2_beta_released
    2011/12/13/tinkerer_0_1_beta_is_out_

File tinkerer/__init__.py

     CONTRIBUTORS file)
     :license: FreeBSD, see LICENSE file
 '''
-__version__ = "0.3.1b"
+__version__ = "0.4b"
 
 master_doc = "master"
 source_suffix = ".rst"

File tinkerer/themes/boilerplate/search.html

     <ul>
     {%- for href, caption, context in search_results -%}
       <li><a href="{{ pathto(item.href) }}">{{ caption }}</a>
+{#- Temporary disabled as context is broken. 
         <div class="context">{{ context|e }}</div>
+-#}
       </li>
     {%- endfor -%}
     </ul>

File tinkerer/themes/boilerplate/static/searchtools.js_t

       start = i;
   });
   start = Math.max(start - 120, 0);
+/* Disabled for now as excerpt doesn't work properly
   var excerpt = ((start > 0) ? '...' : '') +
   $.trim(text.substr(start, 240)) +
-  ((start + 240 - text.length) ? '...' : '');
+  ((start + 240 - text.length) ? '...' : ''); */
+  var excerpt = ''
   var rv = $('<div class="context"></div>').text(excerpt);
   $.each(hlwords, function() {
     rv = rv.highlightText(this, 'highlighted');

File tinkerer/themes/boilerplate/static/style.css

 
 nav li { text-align: center; width: 100%; }
 
+article.document li { line-height: 1.5em; }
+
 div.related li { list-style-type: none; text-align: center; width: 100%; }
 
 /* ==|== non-semantic helper classes ========================================