[GUI Plugin] Action Chains

[capink]

Originally Posted by ownedbycats

Question: If I set this to run on 1 book, can it get around problems when it's running on a selection rather than individual books?

Originally Posted by ownedbycats

Use-case 2: Using an action with a conditional that checks something from the current book.

That is whate template scopes is for. It allows you narrow down the action scope to whatever number of books based on whatever criteria you want. If you want the action to work on some books but not other, use template scope.

Originally Posted by ownedbycats

Use-case 3: This.

The same principle applies here. You narrow it down using template scopes.

Edit: For actions that does not support scopes, namely Calibre Actions, you use the "Search Using Templates" action in the same way you would the template scopes.

[ownedbycats]

Ampersand escape bug in submenus.

[Comfy.n]

Hi, I was testing something else and found I couldn't start the Content Server when running from current source (latest commit: a9cec37) with Action Chains enabled. I had a previous version archived (1.18.3) and server wouldn't start using that version either... After removing Action Chains, content server could be started running from source.

Anyway, I'm reporting this just in case it becomes a relevant issue, as everything is working fine with the latest official 6.15.1 release and AC latest version 1.18.5.

[capink]

Updating to the latest version should take care of this. There were recently some changes in calibre that renders older versions incompatible.

[ownedbycats]

Question: Is intended or unavoidable that a runtime SFE on 'language' shows only the short language codes?

[capink]

Originally Posted by ownedbycats

Question: Is intended or unavoidable that a runtime SFE on 'language' shows only the short language codes?

Let's just say it was easier and involved less work. I was not willing to put in the required work for what I thought would be the least used field/datatype.

[ownedbycats]

Makes sense. By 'unavoidable' I probably meant 'a bit annoying to bother changing'

[ownedbycats]

I am making a formula that displays some statistics:

program:
strcat(
	$author, ' - ', $title, character('newline'),
	'Chapter Count: ', $$#chaptercount, character('newline'),
	'Page Count: ', $$#pagecount,character('newline'),
	'Average Pages per Chapter: ', format_number((divide($$#pagecount, $$#chaptercount)), '{0:5.2f}')
	);

If I run it on multiple books, it only displays information for one. How should I change the template to display information for each selected book?

[capink]

You have one of two approaches:

• One Formulas Action: You replace the formula you have above with this one:
  

  program:
      report = '';
      for book_id in from_selection('id'):
          report = strcat(
              report,
              character('newline'),
              book_field(book_id, 'author'), ' - ', book_field(book_id, 'title'), character('newline'),
              'Chapter Count: ', book_raw_field(book_id, '#chaptercount'), character('newline'),
              'Page Count: ', book_raw_field(book_id, '#pagecount'),character('newline'),
              'Average Pages per Chapter: ', format_number((divide(book_raw_field(book_id, '#pagecount'), book_raw_field(book_id, '#chaptercount'))), '{0:5.2f}'),
              )
      rof;
      report

  As you can see it uses for loop to traverse all selected books (from_selection function). It can access metadata for books using the book_field() and book_raw_field() functions, both of which needs the book_id.
  
  This might be slightly slower than the second approach, I've never done any bench-marking and not interested in doing it, because the speed is fine for me.
  
  
  
• Two Actions Chain (Chain Variables + Formulas): If you don't want to dabble in plugin specific functions like from_selection, book_field ...etc, do the following:
  
  First add a Chain Variables action, then add a variable called report and remember to tick the iterate checkbox, then add this template:
  
  

  program:
      report = globals(report);
      strcat(
          report,
          character('newline'),
          $author, ' - ', $title, character('newline'),
          'Chapter Count: ', $$#chaptercount, character('newline'),
          'Page Count: ', $$#pagecount,character('newline'),
          'Average Pages per Chapter: ', format_number((divide($$#pagecount, $$#chaptercount)), '{0:5.2f}')
          )

  Now add a Formulas Action with the following template:
  
  

  program:
      globals(report)

N.B This is the same approach I talked about when I told you to narrow down the books scope using templates scope. So if you have an action that needs to act on a subset of selected books, you filter the books ids you want to act upon using one of the two above techniques, and feed the list of book_ids to the action via template scopes.

[ownedbycats]

The speed of the first one doesn't seem too much. Thanks

I've been testing out template scopes (duplicating existing chains is helpful for this). I think I've got it mostly figured out by now.

[ownedbycats]

Selection Modifier: Would any of the options select 'initial selection before running chain'?

[capink]

Originally Posted by ownedbycats

Selection Modifier: Would any of the options select 'initial selection before running chain'?

No. You have to save them by creating a Chain Variables as the first action, with a variable called initial_selection:

program:
    from_selection('id')

Whenever you need to re-select these books, create a "Search Using Template" action with the following template:

program:
    globals(initial_selection)

You also have to select the option "Template Output is a list of ids", and tick the checkbox "Select all books resulting from this template"

Notes:

• You have to ensure that the current library view shows all the books, or at least showing the books you are trying to select, so it is better to insert a selection modifier clearing any previous search.
• Using this approach you are not restricted to only choosing the books before running the chain. You can save and restore selection during any point in the chain e.g. restore selection before 3rd action and so on.

[ownedbycats]

Thanks

I think tips and tricks like this would be helpful for the second reserved post

[capink]

There is already a section of Misc Tips in the first post. I will add this to it.

[ownedbycats]

A new question: A while ago, I think you mentioned changes to the icons. Does that include using a custom folder instead of resources/images? Generate Cover and Job Spy both use a folder in plugins, for example.

A few days ago, I couldn't figure out why a tag browser icon had changed until I realized I had a 'series.png' used by Action Chains. (Renaming to icon_series.png fixed it.)