rubyworks / brite

Brite is "Web Write"
http://rubyworks.github.com/brite
Other
5 stars 1 forks source link

Summary Truncation #4

Open ghost opened 14 years ago

ghost commented 14 years ago

Need to improve truncation of summaries. This is tricky for brite because it allows multiple formats per-document, so word counts aren't easily calculated with accuracy.

One alternative I noticed by another blog engine was to use a marker (eg. '~~') to indicate the cut-off point. This is nice b/c it allows the writer to decide where the summary cut-off should be.

Note we can also offer a summary field in the YAML front matter that would be used instead if present.

trans commented 12 years ago

Brite has basically worked around this problem by using the first template section as the summary. In most cases this work perfectly well. One only needs to add an extra --- markdown section (or what have you) where the break should be.

This is only really a problem when one wants multiple sections in the summary, say for instance a code example should be included. So, this is still an issue that needs to be resolved.

Perhaps the front matter could simply have a field for number of sections to include in summary? Hmm... maybe a summary field itself could handle it, if it is a simple integer. Okay, that should work. Put it on the TODO list!