posativ / acrylamid

(unmaintained) static blog generator in python with incremental rendering ⛺
http://posativ.org/acrylamid/
Other
277 stars 40 forks source link

Proposal: add an entry.description boolean argument #228

Open andreamoro opened 9 years ago

andreamoro commented 9 years ago

Playing around with Acrylamid I felt very uncomfortable having entry.description returning a trimmed version of entry.content.

As I appreciate many users could have been using this as a feature, I'd like to propose the inclusion of a boolean parameter in the call to allow new sites being developed not including the description if the argument is set to false.

There is an SEO reason behind, and being able to control whether the description is empty or not could offer other choices other than arbitrarily accepting the value currently returned.

geekman commented 9 years ago

You can include a description in the YAML front matter of each entry.

In addition, I have also added an content.sdescription which you can use in the template body for your SEO needs (see #212).

andreamoro commented 9 years ago

I know that I can add a new field, in fact I have temporarily added a field called description to override the problem. But if I forget to add the entry, or even if you don't define the sdefinition the problem is still there hence the proposal.

posativ commented 9 years ago

You can also disable the inclusion of entry.description by removing the relevant parts from the template (and replace it with a custom version, either generated or manually written). It is just a convenience attribute.