Templates: various questions not worth their own thread

[capink]

You can pass variables to stored templates using the arguments function (read the documentation for more info)

• You should first modify your stored templates to look like this
  

  program:
      arguments(date);
      now = format_date(today(), 'yyyy-MM-dd');
  
      if days_between(date, now) <= '1' then '#aaaaa'
      elif days_between(date, now) <= '3' then '#bbbbb'
      elif days_between(date, now) <= '7' then '#ccccc' 
      fi

• Now you can call the stored template with the date argument as follows:
  

  program:
      colours_daysbetween($#fanficupdated)

[ownedbycats]

That works! Can more than one argument be set per template? e.g. swapping "#aaaa" for "colourA" and then setting that in the external template.

Also, I found out the issue I was having with days_between -- I put the arguments in the wrong order and getting negative numbers which were all less than 1. I think I made this mistake before.

[chaley]

Originally Posted by ownedbycats

That works! Can more than one argument be set per template? e.g. swapping "#aaaa" for "colourA" and then setting that in the external template.

You can pass as many arguments as you want. You can also set it up so that arguments have default values. See the docs.

[ownedbycats]

I've got it.

program:

arguments(date, colourA, colourB, colourC);
now = format_date(today(), 'yyyy-MM-dd');

		if days_between(now,date) <= '1' then colourA
		elif days_between(now,date) <= '7' then colourB
		elif days_between(now,date) <= '14' then colourC fi

program:
    colours_daysbetween($#lastread, '#1c7eff', '#538fff', '#2b5aa2')

(or I could use (colourA='#1c7eff'), thoughI'm not sure there's any reason to do this unless I add more variables)

[ownedbycats]

edit: whoops, figured it out

[chaley]

Originally Posted by ownedbycats

I've got it.

program:

arguments(date, colourA, colourB, colourC);
now = format_date(today(), 'yyyy-MM-dd');

		if days_between(now,date) <= '1' then colourA
		elif days_between(now,date) <= '7' then colourB
		elif days_between(now,date) <= '14' then colourC fi

As you know that days_between() returns a number, I suggest you use numeric comparisons. That will avoid problems caused by the order of the tests. For example, using string comparisons '14' is less than '7'.

Try this:

program:

arguments(date, colourA, colourB, colourC);
		now = format_date(today(), 'yyyy-MM-dd');
		days = days_between(now,date);

		if days <=# 1 then colourA
		elif days <=# 7 then colourB
		elif days <=# 14 then colourC fi

[ownedbycats]

Yes I'll fix that.

Someone I know was learning Python and their program told them that the double of '5' was '55.' Which is correct... if you want to double the string '5' instead of the integer '5.'

[ownedbycats]

Question: Is undefined the same as '0' in a days_between?

program:

	read = $$#lastread;
	updated = $$#fanficupdated;

	if $$#percentread <# 100 && days_between (read, updated) <=# 0 then '#ffff7f'  fi

This activates on books that have an undefined #fanficupdated, though if I change it to <#0 that fixes it.

[chaley]

Originally Posted by ownedbycats

Question: Is undefined the same as '0' in a days_between?

program:

	read = $$#lastread;
	updated = $$#fanficupdated;

	if $$#percentread <# 100 && days_between (read, updated) <=# 0 then '#ffff7f'  fi

This activates on books that have an undefined #fanficupdated, though if I change it to <#0 that fixes it.

days_between() returns the empty string if either parameter isn't a date. Numeric comparison treats the empty string as zero, which is why the comparison succeeds.

I suggest that you don't depend on that, instead being explicit about what happens if dates are undefined. There are at least two ways to do it. The first is to use raw_field() with a default, for example

	read = raw_field('#lastread', today());

which sets read to today() if #lastread is undefined. You can of course put any date you want for the default.

Another way, one that I prefer, is to test if the two dates are defined and do something explicit. Something like this:

program:

	read = $$#lastread;
	updated = $$#fanficupdated;

	if read == 'none' || updated == 'none' then
		'#090909'
	elif $$#percentread <# 100 && days_between (read, updated) <=# 0 then 
		'#ffff7f' 
	fi

or this

program:

	read = $$#lastread;
	updated = $$#fanficupdated;

	if read == 'none' || updated == 'none' then
		days = -1
	else
		days = days_between (read, updated)
	fi;

	if $$#percentread <# 100 && days <=# 0 then 
		'#ffff7f' 
	fi

[ownedbycats]

Yes, I was thinking of adding a test. Though just keeping it <# would work too for this specific case; I was checking that #fanficupdated was newer than #lastread (e.g. when a fanfic updates and I haven't read the new chapter yet).

[ownedbycats]

Question: When using a stored template that returns 'True' if it matches certain criteria (psuedobools), I noticed these work the same:

program:
	if stored_returnstrueifvalid() == 'True' then 'output' fi

program:
	if stored_returnstrueifvalid() then 'output' fi

When do I need I keep the "== 'True'" bit?

Also, is there any good way to test two templates getting same results on a set of books aside from shuffling it between the tester and Notepad? I don't believe there's a way to have two tester instances open.

[chaley]

Originally Posted by ownedbycats

Question: When using a stored template that returns 'True' if it matches certain criteria (psuedobools), I noticed these work the same:

program:
	if stored_returnstrueifvalid() == 'True' then 'output' fi

program:
	if stored_returnstrueifvalid() then 'output' fi

When do I need I keep the "== 'True'" bit?

A conditional expression is False if it evaluates to the empty string, otherwise it is True. As such you don't need the == 'True' part if the stored template return that or the empty string.

Also, is there any good way to test two templates getting same results on a set of books aside from shuffling it between the tester and Notepad? I don't believe there's a way to have two tester instances open.

Some ways:

• You could use calibre-debug -g to have a cmd window, then use the template print() to show values in that window.
• If they are stored templates then you can compare their results in a third template.
• You can create a few extra composite columns and compare the values stored in the columns.

[ownedbycats]

Thanks

I came across some strange behaviour with a new template (ignore the wonky indenting, I removed a lot of other if-thens):

program:
f = re($#chapters, '(.*)/.*', '\1');
s = re($#chapters, '.*/(.*)', '\1');
newpercent = round(multiply ((f / s), 100));
 
					if newpercent < 99 then newpercent 
						else 98
					fi

Basically:

Divide F by S. Multiply it by 100. Round it to the nearest digit. If the number less than 99, use the new number; otherwise set it to 98.

But on line 6 if I add a '#' to if newpercent < #98 for the numeric comparison I get this error:

EXCEPTION:  Formatter: Failed to scan program. Invalid input '#99 then newpercent \n\t\t\t\t\t\telse 98\n\t\t\t\t\tfi' near the end of the program

It works fine if I use it without the #. Did I make a syntax mistake?

EDIT: I misplaced a space. It should've been <# not < #.

[chaley]

Originally Posted by ownedbycats

EDIT: I misplaced a space. It should've been <# not < #.

And it works like that, yes?

You really do want to use <#. Without it the comparison uses lexicographical order where 100 < 99.

[ownedbycats]

Yes it works.