From 5e9a256a912f4152b02dbebdf945905afc60938e Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Tue, 15 Apr 2014 23:43:10 -0400 Subject: [PATCH] Rename render-content to render-text for clarity. Retroactively add to 0.9.3. --- NEWS.md | 1 + docs/plugin-api.md | 2 +- plugins/rst.lisp | 4 ++-- src/coleslaw.lisp | 4 ++-- src/packages.lisp | 2 +- src/posts.lisp | 2 +- 6 files changed, 8 insertions(+), 7 deletions(-) diff --git a/NEWS.md b/NEWS.md index 4b7749d..15d3c1e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,7 @@ ## Changes for 0.9.3 (2013-04-16): * **INCOMPATIBLE CHANGE**: `page-path` and the `blog` config class are no longer exported. +* **INCOMPATIBLE CHANGE**: `render-content` has been renamed `render-text` for clarity. * New Docs: [A Hacker's Guide to Coleslaw](hacking_guide) and [Themes](theming_guide)! * A new theme *readable* based on bootswatch readable, courtesy of @rmoritz! * Posts may have an author to support multi-user blogs courtesy of @tychoish. diff --git a/docs/plugin-api.md b/docs/plugin-api.md index a6c5cab..89ca2d7 100644 --- a/docs/plugin-api.md +++ b/docs/plugin-api.md @@ -28,7 +28,7 @@ * **New markup formats**, for example the [ReStructuredText plugin](http://github.com/redline6561/coleslaw/blob/master/plugins/rst.lisp), - can be created by definining an appropriate `render-content` + can be created by definining an appropriate `render-text` method. The method takes `text` and `format` arguments and is [EQL-specialized](http://www.gigamonkeys.com/book/object-reorientation-generic-functions.html#defmethod) on the format. Format should be a keyword matching the file diff --git a/plugins/rst.lisp b/plugins/rst.lisp index 30158ae..a18ec10 100644 --- a/plugins/rst.lisp +++ b/plugins/rst.lisp @@ -3,7 +3,7 @@ (defpackage :coleslaw-rst (:use :cl) - (:import-from :coleslaw #:render-content) + (:import-from :coleslaw #:render-text) (:import-from :docutils #:read-rst #:write-part #:register-settings-spec #:visit-node #:write-document) (:import-from :docutils.writer.html #:html-writer #:write-part) @@ -11,7 +11,7 @@ (in-package :coleslaw-rst) -(defmethod render-content (text (format (eql :rst))) +(defmethod render-text (text (format (eql :rst))) (register-settings-spec '((:generator nil) (:datestamp nil))) (with-output-to-string (str) diff --git a/src/coleslaw.lisp b/src/coleslaw.lisp index 7107c2a..ad49118 100644 --- a/src/coleslaw.lisp +++ b/src/coleslaw.lisp @@ -58,8 +58,8 @@ (content (construct content-type (read-content file)))) (write-page "tmp.html" (render-page content))))) -(defgeneric render-content (text format) - (:documentation "Compile TEXT from the given FORMAT to HTML for display.") +(defgeneric render-text (text format) + (:documentation "Render TEXT of the given FORMAT to HTML for display.") (:method (text (format (eql :html))) text) (:method (text (format (eql :md))) diff --git a/src/packages.lisp b/src/packages.lisp index cc644e1..f93e0b8 100644 --- a/src/packages.lisp +++ b/src/packages.lisp @@ -13,7 +13,7 @@ #:content #:post #:index - #:render-content + #:render-text #:add-injection ;; The Document Protocol #:add-document diff --git a/src/posts.lisp b/src/posts.lisp index 2c8f3d3..e2748eb 100644 --- a/src/posts.lisp +++ b/src/posts.lisp @@ -12,7 +12,7 @@ (text content-text)) object (setf (content-slug object) (slugify title) format (make-keyword (string-upcase format)) - text (render-content text format) + text (render-text text format) author (or author (author *config*))))) (defmethod render ((object post) &key prev next)