Template language changes

[ownedbycats]

if it follows the same behaviour as annotation_count(), checking it >#0 should also work.

[chaley]

Originally Posted by ownedbycats

if it follows the same behaviour as annotation_count(), checking it >#0 should also work.

Yes, it will, but this is a touch slower if all you want to know is if some files exist. Same thing is true for annotation_count().

I am submitting these changes:

• has_extra_files([pattern]) -- returns the count of extra files, otherwise '' (the empty string). If the optional parameter 'pattern', a regular expression, is supplied then the list is filtered to files that match pattern before the files are counted. The pattern match is case insensitive. This function can be used only in the GUI.
• extra_file_names(sep [, pattern]) -- returns a sep-separated list of extra files in the book's '{}/' folder. If the optional parameter 'pattern', a regular expression, is supplied then the list is filtered to files that match pattern. The pattern match is case insensitive. This function can be used only in the GUI.

[chaley]

27 Apr 2023 (in calibre 6.18)

Changed template functions.

• has_extra_files()
  

  has_extra_files([pattern])

  returns the count of extra files, otherwise '' (the empty string). If the optional parameter 'pattern', a regular expression, is supplied then the list is filtered to files that match pattern before the files are counted. The pattern match is case insensitive. This function can be used only in the GUI.
  
  What changed: the 'pattern' parameter was added and the function returns a count instead of 'Yes'.
• extra_file_names()
  

  extra_file_names(sep [, pattern])

  returns a sep-separated list of extra files in the book's '{}/' folder. If the optional parameter 'pattern', a regular expression, is supplied then the list is filtered to files that match pattern. The pattern match is case insensitive. This function can be used only in the GUI.
  
  What changed: the 'pattern' parameter was added.

[chaley]

Originally Posted by BetterRed

I want to show an icon if the data folder contains a file named todo.???? (might be ToDo.txt, TODO.EML, todo.stky, etc).

Something like extra_file_exists("todo.*") might be useful.

BR

The changed has_extra_files() that takes an optional regexp does what you want, returning a count of files that match the pattern. For example:

program:
	if has_extra_files('^todo\.') then "icon.png" fi

[BetterRed]

Originally Posted by BetterRed

I want to show an icon if the data folder contains a file named todo.???? (might be ToDo.txt, TODO.EML, todo.stky, etc).

Something like extra_file_exists("todo.*") might be useful.

BR

Originally Posted by chaley

program:
	files = extra_file_names(':');
	in_list(files, ':', 'todo\..*', 'Yes', '')

EDIT: where 'Yes' would be the icon name

I see I forgot to thank you for this, so I'm doing it now. Thanks

It works of course but because I use the file manager to add/delete the file to/from the books data folder the column icon doesn't appear/disappear in real time.

Re-apply current sort (F5) doesn't do the trick, perhaps it could/should. Header menu->Restore default layout doesn't do it either. Apart from restart, the only way I've found to get the icon updated, is switching to another library and back again.

BR

[BetterRed]

Originally Posted by BetterRed

. . . because I use the file manager to add/delete the file to/from the books data folder the column icon doesn't appear/disappear in real time.

Re-apply current sort (F5) doesn't do the trick, perhaps it could/should. Header menu->Restore default layout doesn't do it either. Apart from restart, the only way I've found to get the icon updated, is switching to another library and back again.

BR

On reflection, I'm going to take different tack on this; not only does it get rid of the icon update problem, its a better solution to storing transient data like to-do-lists, reminders etc.

I'll put them into a OneNote 'page' and put a link to it in the Links column, then I can set the icon to show if Links contains "To Do in OneNote".

BR

[chaley]

Originally Posted by BetterRed

I see I forgot to thank you for this, so I'm doing it now. Thanks

You are welcome

It works of course but because I use the file manager to add/delete the file to/from the books data folder the column icon doesn't appear/disappear in real time.

Re-apply current sort (F5) doesn't do the trick, perhaps it could/should. Header menu->Restore default layout doesn't do it either. Apart from restart, the only way I've found to get the icon updated, is switching to another library and back again.

BR

Ways to refresh it are (some of these might require the next release -- I don't remember beyond what I noted):

• Using the link to open a file explorer on a book or a book's data folder resets the indicator for that book. In the next release it checks once per second for 5 minutes after you open the explorer. If you do your "File system operations" using that explorer then the icon will automatically update.
• Using "Add data files to books" does the reset for the affected books.
• Selecting the book, doing Edit Metadata, changing nothing, then hit OK, does it for that book.
• Selecting all books then doing Edit Metadata (bulk), changing nothing, then pressing OK does it.
• Editing any cell, for example Title, then hitting return without changing anything does it for that book.
• This python template does it for all books:
  

  python:
  def evaluate(book, context):
  	db = context.db.new_api
  	db.clear_extra_files_cache(None)
  	return 'Ok'

• Use a Python code Action chain, probably with a shortcut. The code is
  

  def run(gui, settings, chain):
      db = gui.current_db.new_api
      db.clear_extra_files_cache(None)
      gui.current_view().model().refresh()

• Of course and as you found, restarting or switching libraries does it.

I don't think doing it on every sort is a good idea, as that would affect performance by making the cache near useless. It also isn't any more discoverable than the above operations.

I considered adding a global refresh action but Kovid thought that such a thing wouldn't be any more discoverable than (for example) Select All then Edit Metadata (bulk) then OK without changing anything.

[BetterRed]

Originally Posted by chaley

Ways to refresh it are (some of these might require the next release -- I don't remember beyond what I noted):

<snip>

I don't think doing it on every sort is a good idea, as that would affect performance by making the cache near useless. It also isn't any more discoverable than the above operations.

I considered adding a global refresh action but Kovid thought that such a thing wouldn't be any more discoverable than (for example) Select All then Edit Metadata (bulk) then OK without changing anything.

FTR: The 'todo.txt' was created by: pressing 'O' to open the book folder, I then opened the already existing 'data' folder in File Explorer, created a todo.txt, saved it and closed File Explorer.

I tried various things to try to get the icon to show, edited a date custom column via F2, added a Tag in the MDE dialogue and saved it, edited a long text column with JobSpy's NoteView, re-sorted the list by clicking on the Author column header, moved columns and refreshed via View Manager's Refresh current view. None of them caused the icon to display.

I 'picked' on Refresh current sort because its default shortcut is F5 which is often used as the shortcut key for 'refresh' - almost a de-facto standard like F1 for Help, F2 for Edit, etc. BTW it is not in the Sort By menu.

But all of that is moot now. It was a bad design decision on my part to use the presence of a todo.* file in the data folder as a signal I needed to do something… classic case of give a bloke a new hammer and everything looks like a nail. I'll put the ON page links into a #todo/To Do column, needless to say I'll put a calibre:\\show-book URL into the ON pages.

Matters arising:

• I think we need a keyboard shortcut to open the data folder, having to press 'O' to open the book folder and then poking around it to open the 'data' folder is… 'hazardous'.
  
• I noticed there are couple of unassigned Copy URL keyboard shortcuts for Metadata Edit that aren't in the Metadata Edit menu.
  
  I think we need a Copy Calibre URL toolbar/menu item that consolidates the Copy links options in the book details and column right click menus. This would make them keyboard accessible (via the book list context menu) and obviate need to show the book details panel to access them.

Slightly off topic. Caste your mind back to when you made the Tag Browser keyboard accessible, I can't find the thread now, but I'm sure you provided a keyboard way of cycling through the +, ++, -, and -- options, I thought it was Space, if it was, it's not working now… otherwise I've forgotten what it was

BR

[ownedbycats]

If 'D' is unutilized*, I think that would make a good default Open Extra Data Folder key.

* is there a list of the defaults somewhere? Ive modified mine a lot.

[BetterRed]

Originally Posted by ownedbycats

If 'D' is unutilized*, I think that would make a good default Open Extra Data Folder key.

* is there a list of the defaults somewhere? Ive modified mine a lot.

JS+ GUI Tool: Active Keyboard Shortcut Assignments

D is default for send to device

Salt on Sauce.

BR

[chaley]

Originally Posted by BetterRed

[...]
Matters arising:

1. I think we need a keyboard shortcut to open the data folder, having to press 'O' to open the book folder and then poking around it to open the 'data' folder is… 'hazardous'.
   
2. I noticed there are couple of unassigned Copy URL keyboard shortcuts for Metadata Edit that aren't in the Metadata Edit menu.
   
   I think we need a Copy Calibre URL toolbar/menu item that consolidates the Copy links options in the book details and column right click menus. This would make them keyboard accessible (via the book list context menu) and obviate need to show the book details panel to access them.

Re #1: I will look at that. Re #2: You are asking that all the Copy URL actions show in the edit metadata action? If so, why put them into a new action as well?

Slightly off topic. Caste your mind back to when you made the Tag Browser keyboard accessible, I can't find the thread now, but I'm sure you provided a keyboard way of cycling through the +, ++, -, and -- options, I thought it was Space, if it was, it's not working now… otherwise I've forgotten what it was

BR

The Return key. And for completeness, the left and right arrow keys open and close categories.

[BetterRed]

Originally Posted by chaley

Re #2: You are asking that all the Copy URL actions show in the edit metadata action? If so, why put them into a new action as well?

I should have been explicit.

I was suggesting the two Copy URL shortcuts in the MDE group be removed, and all the Copy URL actions be gathered onto a dedicated Copy Calibre:// URL tool that can be added to a menu or tool bar. This would include those kept in category link fields, which would make it a dynamic menu.

I doubt more than 10% of calibre users make use of the Copy calibre:// URLs right click actions in book details, and not even 1% would have discovered the two MDE shortcuts… I spotted them when looking for an Open data folder shortcut.

Originally Posted by chaley

The Return key. And for completeness, the left and right arrow keys open and close categories.

Aa-ha, the Typewriter Return key, I would have tried the Numpad Return key

BR

[chaley]

Originally Posted by BetterRed

Matters arising:

• I think we need a keyboard shortcut to open the data folder, having to press 'O' to open the book folder and then poking around it to open the 'data' folder is… 'hazardous'.

In source now: the "Open book folder" action has a drop-down menu offering to open either the book folder or the book data folder. Either can have a shortcut. Opening the book folder defaults to O (as before). Opening the data folder doesn't have a default. You can put the action wherever you want: toolbars and/or the context menu.

NB: In the process renamed the action from "Open containing folder" to "Open book folder".

[BetterRed]

Originally Posted by chaley

In source now: the "Open book folder" action has a drop-down menu offering to open either the book folder or the book data folder. Either can have a shortcut. Opening the book folder defaults to O (as before). Opening the data folder doesn't have a default. You can put the action wherever you want: toolbars and/or the context menu.

NB: In the process renamed the action from "Open containing folder" to "Open book folder".

I don't use Send to Device, so 'D' is waiting in the wings. What happens of there is no 'data' subfolder?

BR

[ownedbycats]

https://github.com/kovidgoyal/calibre/pull/1899

Add opening the data folder to the Open action. Allow it to have a shortcut. Create the data folder if it doesn't exist.