/CHANGELOG.rst

Relevant Search: With Applications for Solr and Elasticsearch

For more in depth reading about search, ranking and generally everything you could ever want to know about how lucene, elasticsearch or solr work under the hood I highly suggest this book. Easily one of the most interesting technical books I have read in a long time. If you are tasked with solving search relevance problems even if not in Solr or Elasticsearch it should be your first reference. Amazon Affiliate Link

  1Version TBA
  2===========
  3
  4* Experimental Python 3 support
  5
  6
  7Version 0.8.9 (2015-11-09)
  8===========================================================
  9
 10*   Add mailing list and IRC channel information to README.
 11*   Relax the version numbers (with an upper bound on major version) for
 12    dependencies.
 13
 14Thanks to @jonafato:
 15
 16*   Update command and fswrap dependencies.
 17*   Use setuptools directly.
 18*   Improve travis builds.
 19    - add caching support.
 20    - prevent duplicate builds.
 21    - add support for new container based builds.
 22*   Move tests out of the hyde package.
 23
 24Thanks to @bheesham:
 25
 26*   Bugfix: Fix favicon and apple touch icon paths in basic template.
 27
 28Thanks to @jd:
 29
 30*   Bugfix: Paginator fails when there is no meta variable.
 31*   Add tox support.
 32*   Fix setup.py and make it pep8 compliant.
 33*   Add pages list to resources in paginator plugin.
 34
 35Thanks to @mtahmed:
 36
 37*   Bugfix:  Ensure that `self.q` is assigned to None when PyQuery is unavilable.
 38
 39Thanks to @ftao:
 40
 41*   Bugfix: Remove typo in sphinx plugin commando import.
 42
 43Thanks to Alexey Biryukov:
 44
 45*   Hyde now supports assigning jinja2 custom tests similar to custom filters in site.yaml.
 46
 47Thanks to @llonchj:
 48
 49*   Huge updates to unit tests, development dependencies (flake8, pep8 etc).
 50*   Travis support.
 51*   The ``h`` binary is now deprecated and will be removed in one of the future releases.
 52*   libsass support.
 53
 54
 55Version 0.8.8 (2013-08-20)
 56===========================================================
 57
 58*   Bugfix: Fix smartypants to 1.7.x to avoid the breaking
 59    changes in 1.8.  (Issue #229)
 60*   Bugfix: Upgrade Jinja to 2.7.1 - this fixes
 61    mitsuhiko/jinja2#243.
 62
 63Thanks to @shym:
 64*   Fix various typos in documentation and code. (Issue #227)
 65
 66Thanks to @maethor:
 67*   Make username optional in SSH publisher. (Issue #222)
 68
 69Thanks to @merlinrebrovic:
 70*   Refresh the starter layout: (Issue #220)
 71
 72    - Conform to changes from the newest Hyde version.
 73    - Clean up Markdown and add explanations.
 74    - Increase font sizes.
 75    - Remove HTML5 shiv and hgroup element (deprecated).
 76    - Other minor improvements.
 77
 78Thanks to @webmaster128:
 79*   Bugfix: Add spaces to menu in ``starter`` layout. (Issue #219)
 80
 81Version 0.8.7 (2013-05-30)
 82============================================================
 83
 84*   Bugfix: Ensure dependencies are handled properly when using the
 85    combine plugin. (Issue #120).
 86*   Bugfix: Ensure external urls are encoded properly. (Issue #158).
 87
 88    -   **BREAKING**:  While this change will correct the weird encoding
 89        behavior, this also changes the way ``xxx_url`` macros work.
 90    -   Do not encode the url bases (``base_url``, ``media_url``). Only
 91        the path component needs to be encoded.
 92
 93*   Bugfix: Fix subfolders for root paths on windows. (Issue #167).
 94
 95    -   Ensure that subfolders for ``layout_root``, ``content_root``,
 96        ``media_root`` and ``deploy_root`` works reliably
 97        on windows. Use ``fully_expanded_path`` for all path components.
 98
 99*   Bugfix: Context providers now accept all valid yaml data (Issue #189).
100*   Bugfix: Fixed ``raise_exceptions`` command line parameter handling.
101*   Better exception handling. (Issue #204)
102
103    -   Hyde now propagates exceptions
104    -   Hyde does not raise exceptions by default. ``-x`` flag is required
105        for raising exceptions on error.
106    -   Traceback is available in the ``verbose`` mode
107
108*   Upgraded to commando 0.3.4
109*   Upgraded to Jinja 2.7
110*   Make sorter's prev/next links circular. (Issue #208)
111*   Bugfix: Include project artifacts in sdist. (Issue #211)
112
113    -   Add LICENSE, AUTHORS and CHANGELOG to MANIFEST.in
114
115*   Add "Hyde contributors" to LICENSE copyright.
116*   Upgrade ``UglifyPlugin`` to use 2.3.5 version of uglify. (Issue #214)
117*   Add support for draft blog posts. (Issue #213)
118*   Bugfix: Use ``clearfix`` class in ``listing.j2``. (Issue #156)
119*   Bugfix: Use ``relative_path`` instead of url in ``macros.j2``. (Issue #180)
120
121
122Version 0.8.6 (2013-04-30)
123============================================================
124
125Thanks to @QuLogic:
126
127*   Refactor: Plugins reorganized by function. (Issue #170)
128*   Add HG Dates Plugin. (Issue #177)
129*   Add Clever CSS Plugin. (Issue #178)
130*   Add Sassy CSS Plugin. (Issue #179)
131
132Thanks to @sirlantis:
133
134*   Add support for custom jinja filters. (Issue #159)
135
136Thanks to @gfuchedzhy
137
138*   Bugfix: Serve files without a resource. (Issue #92)
139
140Thanks to @ilkerde:
141
142*   Add Require JS plugin. (Issue #201)
143
144Thanks to @jakevdp:
145
146*   Add SSH publisher. (Issue #205)
147
148Thanks to @herr-lehmann and @nud:
149
150*   Bugfix: Fix date time comparison in git plugin. (Issue#142, #199, #137)
151
152Thanks to @rephorm, @gfuchedzhy and @vincentbernat:
153
154*   Add thumbnail plugin. (Issue #169, #89)
155
156Thanks to @vincentbernat:
157
158*   Add Coffeescript plugin. (Issue #172)
159*   Add jpegtran plugin. (Issue #171)
160
161Thanks to @jabapyth:
162
163*   Add extension support for restructured text. (Issue #206)
164
165Thanks to @tarajane:
166
167*   Bugfix: Update the .clear styleName to be .clearfix instead.
168    Base.j2 applies the 'clearfix' class to the 'banner' element, and not
169    the 'clear' class. (Issue #156)
170
171Thanks to @pib:
172
173*   Bugfix: Use ``_transform`` instead of ``transform`` in Expando.
174    (Issue #152, #153)
175
176Version 0.8.5 (2013-04-17)
177============================================================
178
179*   Upgrade dependencies and setup for 0.8.5
180*   Remove ``hyde.fs`` use ``fswrap`` package instead.
181*   Remove logging functions from ``hyde.util``. Use ``commando.util`` instead.
182*   Remove ``hyde.loader``. Use ``commando.util.load_python_object`` instead.
183*   Bugfix: Use the released version of typogrify. (Issue #193)
184*   Bugfix: Fixed stylus ``indent`` issues with empty files. (Issue #161)
185*   Bugfix: Added support for plugin paths relative to site. (Issue #107)
186*   Bugfix: Folder Flattener updates node's ``relative_deploy_path`` & ``url``
187    attributes as well. (Issue #126)
188*   BREAKING: As part of the above fix, ``resource.url`` is
189    prefixed with a ``/``. (Issue #126)
190*   Added ``simple_copy`` feature to account for unprocessable files that
191    are nonetheless required to be deployed (Issue #121)
192*   Bugfix: Relative path was used in the server as the sitepath (Issue #119)
193*   Plugins now support inclusion filters. (Issue #112)
194
195    -   ``include_file_patterns`` property accepts globs to filter by file name.
196    -   ``include_paths`` accepts paths relative to content.
197    -   ``begin_node`` and ``node_complete`` honor ``include_paths``
198    -   ``begin_text_resource``, ``text_resource_complete``,
199        ``begin_binary_resource`` and ``binary_resource_complete`` honor both.
200
201*   Bugfix: Unsorted combine files fixed. (Issue #111)
202*   Added an optional sorting parameter. (Issue #111)
203*   Bugfix:  Modified combine plugin to process during
204    ``begin_text_resource``. (Issue #110)
205*   Modified combine plugin to support relative paths and recursion.
206    (Issue #108)
207*   Added ability to specify safe characters in ``content_url``,
208    ``media_url`` functions and ``urlencode`` filter. (Issue #103)
209
210Thanks to @idank
211
212*   Bugfix: Use ``check_output`` to avoid a traceback when subprocess
213    command fails.
214*   Bugfix: Tag archive generator uses subscript syntax to avoid failure
215    when tags contain '-' or space. (Issue #130)
216
217Thanks to @jd
218
219*   Bugfix: Metadata Plugin: Do not try to read meta data on ``simple_copy``
220    files. (Issue #124, Issue #121)
221*   Bugfix: Force escape on title in Atom feed. (Issue #176)
222*   Add ``node.rwalk`` method for traversing the node in reverse. (Issue #176)
223
224Thanks to @vinilios
225
226*   Added a helper method in Expando class to ease up non existing keys
227    handling. (Issue #117)
228*   Some improvements in LessCSSPlugin to be able to build complex less
229    projects (such as twitter bootstrap) (Issue #117)
230
231Thanks to @Erkan-Yilmaz
232
233*   Fixed typos in README.
234
235Thanks to @merlinrebrovic
236
237*   Updates and improvements to the starter template.
238
239    * Cleans up CSS.
240    * Handles page title endings more elegantly.
241    * Renders the advanced menu below the basic one.
242    * Corrects and updates content.
243    * Explains how to generate and serve the template.
244    * Makes it more straightforward to contribute.
245
246Thanks to @joshgerdes:
247
248*   Made urlencoding safe character list configurable. (Issue #150)
249
250Thanks to @irrelative:
251
252*   Bugfix: Avoid index error if there aren't pages when iterating
253    for paginator. (Issue #190)
254
255Thanks to @davefowler:
256
257*   Bugfix: Infinate recursion error with resource dependencies.
258    (Issue #155, Issue#200)
259
260Thanks to @adube:
261
262*   Bugfix: Fix atom.j2 to use ``relative_path`` instead of ``url`` when
263    referencing templates. (Issue #155, Issue#203)
264
265
266Version 0.8.4 (2011-11-09)
267============================================================
268
269*   Bugfix: Configuration now gets reloaded when server regenerates (Issue #70)
270*   Bugfix: Added styles for codebox (Issue #69)
271*   Tagger now generates archives upfront in begin_site (Issue #72)
272*   **Breaking**: The default nodemeta file has been changed to meta.yaml
273*   Added test for codehilite markdown extension (Issue #82)
274*   Added rst_directive.py from the pygments repository (Issue #82)
275*   Added support for ignoring nodes (Issue #80)
276*   Hyde now ignores .hg, .svn and .git by default (Issue #80)
277*   Added support for default publisher (Issue #83)
278*   Added ``urlencode`` and ``urldecode`` filters. (Issue #102)
279*   Bugfix: Fixed tests for Issue #88
280*   Added tests for sorting groups
281*   Added support for loading modules from the site path. Thanks to
282    @theomega for the idea (Issue #78 & #79)
283*   Added docutils to dev-req.txt
284*   Bugfix: Fixed uglify-js tests
285
286Thanks to @nud
287
288*   ``$PATH`` based executable discovery for ``CLTransformer`` plugins.
289    (Issue #100)
290*   Bugfix: Fix class name of ``test_stylus`` (Issue #97)
291
292Thanks to @gfuchedzhy
293
294*   Bugfix: Textlinks plugin: do nothing if resource doesn't use template.
295    (Issue #96)
296*   Bugfix: Retain permissions in text files during generation (Issue #90)
297*   Bugfix: Added support for encoded urls to hyde server. (Issue #88)
298*   Bugfix: Converted ``content_url`` and ``media_url`` to encoded urls.
299    (Issue #88)
300*   Bugfix: All occurrences of ``str`` replaced with ``unicode``.
301    (Issue #87)
302*   Bugfix: CLTransformer now gracefully handles arguments that have "=".
303    (Issue #58)
304
305Thanks to @vincentbernat
306
307*   Support for ``output_format`` configuration in markdown (Issue #89)
308
309Thanks to @merlinrebrovic
310
311*   Hyde starter kit extended with advanced options (Issue #68)
312
313Thanks to @tcheneau
314
315*   Added support for AsciiDoc. (Issue #76)
316
317Thanks to @gr3dman
318
319*   Added paginator plugin and tests (Issue #73)
320
321Thanks to @benallard
322
323*   Added restructuredText plugin (Issue #63)
324*   Added restructuredText filter (Issue #63)
325*   Added traceback support for errors when server is running (Issue #63)
326
327Thanks to @rfk
328
329*   Added Sphinx Plugin (Issue #62)
330*   Bugfix: PyFS publisher now checks if the pyfs module is installed.
331    (Issue #62)
332
333Version 0.8.3 (2011-06-20)
334============================================================
335
336*   Bugfix: A bad bug in Expando that modified the ``__dict__`` has been fixed.
337    (Issue #53)
338*   Tags now support metadata. Metadata can be provided as part of the tagger
339    plugin configuration in ``site.yaml``
340*   Ensured that the context data & providers behave in the same manner. Both
341    get loaded as expandos. (Issue #29)
342*   ``hyde serve`` now picks up changes in config data automatically.
343    (Issue #24)
344*   Bugfix: ``hyde create`` only fails when ``content``, ``layout`` or
345    ``site.yaml`` is present in the target directory. (Issue #21)
346*   Bugfix: Exceptions are now handled with ``ArgumentParser.error``.
347*   Bugfix: Sorter excludes items that do not have sorting attributes.
348    (Issue #18)
349*   Wrapped ``<figure>`` inside ``<div>`` to appease markdown. (Issue #17)
350*   Added ``display:block`` for html5 elements in basic template so that it
351    works in not so modern browsers as well. (Issue #17)
352
353Thanks to Joe Steeve.
354
355*   Changed deploy location for main.py and fixed entry point in
356    ``setup.py``. (Issue #56)
357
358Thanks to @stiell
359
360*   Bugfix: Better mime type support in hyde server (Issue #50)
361*   Bugfix: Support empty extension in tagger archives (Issue #50)
362
363Thanks to @gfuchedzhy
364
365*   Bugfix: Hyde server now takes the url cleaner plugin into account.
366    (Issue #54)
367
368Thanks to @vincentbernat
369
370*   Bugfix: Ensure image sizer plugin handles external urls properly.
371    (Issue #52)
372
373Thanks to @rfk
374
375*   Added PyPI publisher (Issue #49)
376*   Bugfix: Made ``site.full_url`` ignore fully qualified paths (Issue #49)
377
378Thanks to @vincentbernat
379
380*   Added JPEG Optim plugin (Issue #47)
381*   Fixes to CLTransformer (Issue #47)
382
383Version 0.8.2 (2011-05-10)
384============================================================
385
386Thanks to @merlinrebrovic
387
388*   Added hyde starter kit (Issue #43)
389
390Thanks to @vincentbernat
391
392*   Added git dates plugin (Issue #42)
393*   Added Image size plugin (Issue #44)
394*   Added silent, compress and optimization parameter support for less css
395    plugin (Issue #40)
396*   Fixed plugin chaining issues (Issue #38)
397*   Added Language(translation) plugin (Issue #37)
398*   Bugfix: Made sorting tests more predictable (Issue #41)
399*   Bugfix: Added more standard paths for executables (Issue #41)
400*   Added Combine files plugin (Issue #39)
401*   Added ignore option in site configuration to igore based on wildcards
402    (Issue #32)
403
404Thanks to @pestaa
405
406*   Added support ``UTF8`` keys in ``metadata`` and ``config`` (Issue #33)
407
408
409Version 0.8.1 (2011-05-09)
410============================================================
411
412Thanks to @rfk.
413
414*   Updated to use nose 1.0 (Issue #28)
415*   Bugfix: LessCSSPlugin: return original text if not a .less file
416    (Issue #28)
417*   PyFS publisher with mtime and etags support. (Issue #28)
418
419Version 0.8 (2011-04-13)
420============================================================
421
422*   Relative path bugs in windows generation have been fixed.
423
424Version 0.8rc3 (2011-04-12)
425============================================================
426
427*   Fixed a jinja2 loader path issue that prevented site generation in windows
428*   Fixed tests for stylus plugin to account for more accurate color
429    manipulation in the latest stylus