A simple link to Shelfmark? Edit: Or not

[lossofworth]

Since shelfmark is like a companion app and even promoted on the readme, could we add a link to a shelfmark instance on the main cwa page? Same as shelfmark has on their main page leading to calibre/cwa.

Possibly under "Feature Configuration" on the Basic Configuration page. Something like "Show link to Shelfmark" with a checkbox, then a text box to type in the URL of shelfmark. If you don't want to be too closely associated, it could be "Show link to external resource". Once it's filled in, there's another icon in the top right, near tasks, refresh, settings, etc.

Edit:
I've been at this for over 2 days straight and I'm banging my head against the wall. I think I have most of it figured out but one thing is driving me nuts. I created SQL records using config_sql.py, added the appropriate HTML into config_edit.html, changed admin.py to ensure it wrote to the config database, then added appropriate HTML to the layout.html template along with the corresponding CSS and main.js to make it nice and pretty. Here's where I'm stuck. To populate the URL for the link I'm using {{ config.config_shelfmark_url }}. This works!.... only when I'm on the /admin/view and admin/config pages.

So, I know that the sql records are there, I just can't access them outside of those two pages. I know the hardcover token can be accessed other places (that's what I based a lot of my edits off of) as well as other config_ records. I'm assuming it has something to do with Flask and how it's calling it? Any help would be greatly appreciated. I have a fork I can make public for anyone that wants to check it out.

Thank you!

[zuhairhalawa]

config inside a Jinja template is Flask's own template global (app.config), unless the view passes its own config= into the render context. The admin views do: cps/admin.py calls render_title_template("admin.html", ..., config=config, ...) (and the same for config_edit.html and a few others), which shadows the global with Calibre-Web's config object. That's why {{ config.config_shelfmark_url }} resolves on /admin/view and /admin/config. On every other page the name config is Flask's config dict, the lookup finds no such key and renders an empty string.

render_title_template() in cps/render_template.py passes instance, sidebar, simple, accept, magic_shelf_routes and duplicate_notification to render_template, but not config. The simplest fix is to pass the value explicitly there:

return render_template(instance=config.config_calibre_web_title, sidebar=sidebar, simple=simple,
                       accept=config.config_upload_formats.split(','),
                       shelfmark_url=config.config_shelfmark_url,
                       magic_shelf_routes=magic_shelf_routes,
                       duplicate_notification=duplicate_notification,
                       *args, **kwargs)

and then use {{ shelfmark_url }} in layout.html. A Flask @app.context_processor that returns the same entry also works (see the "Context Processors" section of the Flask templating docs).

[zuhairhalawa]

If passing the value through render_title_template (or a context processor) fixes it in your fork, could you mark the answer as accepted? Thanks!

[lossofworth]

Yes! Thank you so much for the quick reply. That worked perfectly (after a typo incident). I used explicitly passing the value. I'll look into context_processor in case they don't like explicitly defining it. Hooray for my first pull request!

[zuhairhalawa]

Glad it worked, and congratulations on your first pull request. Passing the value explicitly is fine. A context processor is only an alternative, so use whichever the maintainers prefer when they review it. Good luck with the PR.