Add plugin to create crumbs based on metadata #268
Conversation
|
This is my first plugin so feedback appreciated. It seems crumbs.tmpl was renamed to breadcrumbs.tmpl so I think I should change the name of the plugin to pretty_breadcrumbs. |
|
v2: fixed a pylint error and changed the name to |
v8/pretty_breadcrumbs/.gitignore
Outdated
| @@ -0,0 +1 @@ | |||
| __pycache__ | |||
There was a problem hiding this comment.
should not be necessary, we have that in a global .gitignore for this repo
| .. crumb: This is a test | ||
| ``` | ||
|
|
||
| the breadcrumb generated would be `This is a test` instead of `test`. |
There was a problem hiding this comment.
how about defaulting to titles? Try crumb first, if it doesn’t exist, use title
There was a problem hiding this comment.
Titles are usually quite long and I think the filepath (slug) is better than the title if no crumb is defined.
But maybe this should be a config option.
|
|
||
| # By default, the pretty_crumbs plugin looks for the metadata tag `crumb`. | ||
| # This can be changed with PRETTY_BREADCRUMBS_TAG. | ||
| #PRETTY_BREADCRUMBS_TAG = "nav" |
There was a problem hiding this comment.
I honestly wouldn’t bother with configurability.
There was a problem hiding this comment.
I put the config option in because I use nav for historical reasons but it's easy enough to change it to crumb. I can drop the config if you don't think it's useful.
| tag = 'crumb' | ||
|
|
||
| def pretty_get_crumbs(path, is_file=False, index_folder=None, lang=None): | ||
| lang = lang if lang else self.site.default_lang |
There was a problem hiding this comment.
use LocaleBorg’s current language in the default case (tons of examples in Nikola core)
| else: | ||
| file = os.path.normpath(os.path.join(path, link)) | ||
| if not is_file: | ||
| file += "/" + self.site.config['INDEX_FILE'] |
There was a problem hiding this comment.
Use os.sep instead of "/" for Windows compatibility
There was a problem hiding this comment.
I'll use os.path.join(). That's even cleaner
The `pretty_crumbs` plugin takes metadata information from the source file (by default, the `crumbs` variable but this can be configured) and uses that information for the breadcrum instead of the file/dirname. Thanks to Chris Warrick for answering several questions I had as I worked on this plugin.
Well, that's up to you. Let me know if you prefer a plugin or a patch against utils.get_crumbs |
|
I pushed a new version. I haven't removed PRETTY_BREADCRUMBS_TAG yet but I'm happy to do that. I'll defer to you on this. |
|
It’s a plugin, so anything goes. As for an upstream patch, I’m not really sure about it. It can live as a plugin. |
The
pretty_crumbsplugin takes metadata information from the sourcefile (by default, the
crumbsvariable but this can be configured) anduses that information for the breadcrum instead of the file/dirname.
Thanks to Chris Warrick for answering several questions I had as I
worked on this plugin.