Using templates for file names, plugboards, composite columns, searches, tooltips

[crissman]

Originally Posted by eschwartz

Ah, yes.

The brackets are reserved in template mode. That's why I like general program mode. Well, that and you can limit yourself to only using one custom column.

Use the general program mode version found here: http://manual.calibre-ebook.com/temp...l-program-mode
Simply fix the "stripped" variable.

PHP Code:

program:
#       compute the equivalent of the composite fields and store them in local variables
stripped = re(field('series'), '^(A|The|An)\s+', '');
shortened = shorten(stripped, 4, '-' ,4);
initials = re(stripped, '[\s]?([^\s])[^\s]+(\s|$)', '\1');

#       Format the series index. Ends up as empty if there is no series index.
#       Note that leading and trailing spaces will be removed by the formatter,
#       so we cannot add them here. We will do that in the strcat below.
#       Also note that because we are in 'program' mode, we can freely use
#       curly brackets in strings, something we cannot do in template mode.
s_index = template('{series_index:0>2.0f}');

#       print(stripped, shortened, initials, s_index);

#       Now concatenate all the bits together. The switch picks between
#       initials and shortened, depending on whether there is a space
#       in stripped. We then add the brackets around s_index if it is
#       not empty. Finally, add the title. As this is the last function in
#       the program, its value will be returned.
strcat(
    switch(
        stripped,
        '.\s',
        initials,
        '.',
        shortened,
        field('series')
    ),
    test(
        s_index,
        strcat(' [', s_index, '] '),
        ''
    ),
    field('title')
); 


This worked like a charm, I apprehension I felt when I initially saw this was quite daunting, I did however manage it without a problem. I have absolutely no programming skills whatsoever being more technically inclined.

Also the regex was exactly what I was looking for which just proves I was correct in asking in the first place. I originally thought it was an un-modifiable field other then manually entering in something or downloading the data.

I am very grateful for all your help, a couple of days ago my laptop died and then by backup was corrupted, so I lost everything I had with the exception to what I had stored in the cloud and felt that this was the best time to recreate stuff that I have been wanting to solve for a little while.

So new Laptop and backup drive and calibre is at the point to where I can just sit back and enjoy it.

I do have one small thing that is eluding if you wouldn't mind once again helping me with.

In Metadata Plugboards I have template set up for:

Epub and Any Device
Source template: {title} - {series}{series_index:0>3s| [|]
Destination Field: title

When dealing with series it works perfectly, but when dealing with a book that is not part of a series I have a dash leftover

Example: Ken Follets Book: Edge of Eternity
becomes:
Edge of Eternity - The Century Trilogy [03]

Cottam, F. G. Book: The Lazarus Prophecy
becomes:
The Lazarus Prophecy -

How can I get it to drop the "-" at the end of the title on a book with no series? Yet keep it for series?

Thank you very much eschwartz!

[eschwartz]

Use:

{title}{series:| - |}{series_index:0>3s| [|]}

Explanation (see http://manual.calibre-ebook.com/temp...ced-formatting for the gory details):

Everything after the ":" is a modifier. The "|stuff|stuff" are prefixes and suffixes for the parent template (in this case, series) -- as you can see, you already have one for series_index.

This allows for making stuff dependent on the parent template existing. So. I simply moved the space and dash to be dependent on the series field not being empty.

[eschwartz]

Originally Posted by crissman

This worked like a charm, I apprehension I felt when I initially saw this was quite daunting, I did however manage it without a problem. I have absolutely no programming skills whatsoever being more technically inclined.

Solutions here are copy-paste, because we know not everyone need have pogramming skills.

Also the regex was exactly what I was looking for which just proves I was correct in asking in the first place. I originally thought it was an un-modifiable field other then manually entering in something or downloading the data.

I am very grateful for all your help, a couple of days ago my laptop died and then by backup was corrupted, so I lost everything I had with the exception to what I had stored in the cloud and felt that this was the best time to recreate stuff that I have been wanting to solve for a little while.

Thank you very much eschwartz!

You're welcome.

[chaley]

Originally Posted by eschwartz

Everything after the ":" is a modifier. The "|stuff|stuff" are prefixes and suffixes for the parent template (in this case, series) -- as you can see, you already have one for series_index.

This allows for making stuff dependent on the parent template existing. So. I simply moved the space and dash to be dependent on the series field not being empty.

FWIW: you can use the finish_formatting function instead of the template and test to format it and add the spaces and brackets. Something like

s_index = finish_formatting(field('series_index'), '.2f', ' [', ']'))

[BetterRed]

If I want

if (tags:count(,) > 5)
     return "too many" 
else
     return ""
endif

Why cant I do this

{cmp(tags:count(','), 5, "", "", "too many")}

BR

[DMee]

Originally Posted by eschwartz

Ah, yes.

The brackets are reserved in template mode. That's why I like general program mode. Well, that and you can limit yourself to only using one custom column.

Use the general program mode version found here: http://manual.calibre-ebook.com/temp...l-program-mode
Simply fix the "stripped" variable.

Getting there :-)

I changed formulas to

stripped = re(field('series'), '^(A|The|An)\s+', '');
shortened = shorten(stripped, 8, '-' ,6);
initials = re(stripped, '[\s]?([^\s]{1,3})[^\s]+(\s|$)', '\1');

But summats wrong

Worlds Without End
becomes
WorWitEn

Missing "d"?
Also is it poss to have it as

Wor-Wit-End

Also, is it feasible to add in the code we rejigged when doing series with fractions? you had a prog to decide which formula to use to reformat the series link properly depending on size of highest number and presence of fractions :-)

[chaley]

Originally Posted by BetterRed

If I want

if (tags:count(,) > 5)
     return "too many" 
else
     return ""
endif

Why cant I do this

{cmp(tags:count(','), 5, "", "", "too many")}

BR

There are three different template program modes. The first, single function mode (SFM), has the approximate syntax

{ fieldKey : format/function | prefix | suffix }

You don't quote anything, and the value of the field is implicitly passed to the one function (if there is one).

The second is template program mode (TPM), and has the approximate syntax

{ field name :'possibly nested functions'}

Note the apostrophes. I left off the prefix and suffix. You can use arbitrary function nesting in TPM. There are no implicit parameters. TPM has problems if the function arguments contain { } characters, because these are processed by the outer macro processor before the template compiler is called.

The third is general program mode (GPM). This mode has a more "classic" program style. It is considered as one template, where the other two can be chains of templates. GPM has no restrictions on characters used. It is the most expressive of all the three.

Unfortunately your example uses nested functions but does not use TPM syntax. It also uses attribute-like referencing (tags:count) which doesn't exist in the language.

The equivalent in TPM is

{tags:'cmp(count($, ','), 5, "", "", "too many")'}

In GPM it could be (indentation fully optional):

program: 
	cmp(
		count(
			field('tags'), 
			','), 
		5, 
		"", 
		"", 
		"too many")

[DMee]

Whilst I am asking - how would I get a column of the length of the title - I have some that have ended up massively long and I want to quickly find them and edit them :-)

[DMee]

Originally Posted by DMee

Getting there :-)

I changed formulas to

stripped = re(field('series'), '^(A|The|An)\s+', '');
shortened = shorten(stripped, 8, '-' ,6);
initials = re(stripped, '[\s]?([^\s]{1,3})[^\s]+(\s|$)', '\1');

But summats wrong

Actually its not handling and words 3 or less properly - loses last letter??

[chaley]

Originally Posted by DMee

Whilst I am asking - how would I get a column of the length of the title - I have some that have ended up massively long and I want to quickly find them and edit them :-)

The template is

{title:strlen()}

Originally Posted by DMee

Actually its not handling and words 3 or less properly - loses last letter??

Try

initials = re(stripped, '[\s]?([^\s]{1,3})[^\s]*(\s|$)', '\1');

Originally Posted by DMee

Also is it poss to have it as

Wor-Wit-End

Does this do what you want?

initials = re(list_re(stripped, ' ', '[\s]?([^\s]{1,3})[^\s]*(\s|$)', '\1'), ' ', '-');

[eschwartz]

Originally Posted by chaley

FWIW: you can use the finish_formatting function instead of the template and test to format it and add the spaces and brackets. Something like

s_index = finish_formatting(field('series_index'), '.2f', ' [', ']'))

Thanks.

I already know about it, though. I do use it when in general program mode.

EDIT: It came true sooner than I thought. Look at the recycled s_index below.

[eschwartz]

Originally Posted by DMee

Getting there :-)

I changed formulas to

stripped = re(field('series'), '^(A|The|An)\s+', '');
shortened = shorten(stripped, 8, '-' ,6);
initials = re(stripped, '[\s]?([^\s]{1,3})[^\s]+(\s|$)', '\1');

But summats wrong

Worlds Without End
becomes
WorWitEn

Missing "d"?

Well, chaley has already answered this.

The previous template assumed only the first letter would be captured, and matched the following letters outside the capture. But it required there to be letters outside, under the assumption that any word would have at least two letters. So at least one letter at the end would not be included.

hence chaley's fix.

Also is it poss to have it as

Wor-Wit-End

@chaley, cool use of list_re() -- I am still trying to get my head around using them. Well, list_re_group() specifically. I'm sure they will eventually click into place though.

Thanks, and thank you for all these recent extensions to template programming! They will no doubt make things easier as soon as I get the hang of them.

Also, is it feasible to add in the code we rejigged when doing series with fractions? you had a prog to decide which formula to use to reformat the series link properly depending on size of highest number and presence of fractions :-)

You mean this?

PHP Code:

program:

ser_num = test(
    field('#complex_series'),
    finish_formatting(
        field('series_index'),
        '_>7.2f',
        ' [',
        '] '
    ),
    finish_formatting(
        field('series_index'),
        '_>4d',
        ' [',
        '] '
    ),
);

strcat(
    field('series'),
    ser_num,
    field('title')
) 


Um, lessee...

Ah, it's easy. Just replace s_index.

PHP Code:

program:
#       compute the equivalent of the composite fields and store them in local variables
stripped = re(field('series'), '^(A|The|An)\s+', '');
shortened = shorten(stripped, 4, '-' ,4);
initials = re(list_re(stripped, ' ', '[\s]?([^\s]{1,3})[^\s]*(\s|$)', '\1'), ' ', '-');

#       Format the series index. Ends up as empty if there is no series index.
#       Note that leading and trailing spaces will be removed by the formatter,
#       so we cannot add them here. We will do that in the strcat below.
#       Also note that because we are in 'program' mode, we can freely use
#       curly brackets in strings, something we cannot do in template mode.
#
#       Using the new ser_num calculation from https://www.mobileread.com/forums/showpost.php?p=2916022&postcount=548
s_index = test(
    field('#complex_series'),
    finish_formatting(
        field('series_index'),
        '_>7.2f',
        ' [',
        '] '
    ),
    finish_formatting(
        field('series_index'),
        '_>4d',
        ' [',
        '] '
    ),
);

#       print(stripped, shortened, initials, s_index);

#       Now concatenate all the bits together. The switch picks between
#       initials and shortened, depending on whether there is a space
#       in stripped. We then add the brackets around s_index if it is
#       not empty. Finally, add the title. As this is the last function in
#       the program, its value will be returned.
strcat(
    switch(
        stripped,
        '.\s',
        initials,
        '.',
        shortened,
        field('series')
    ),
    test(
        s_index,
        strcat(' [', s_index, '] '),
        ''
    ),
    field('title')
); 


EDIT: added chaley's fix to the new template.

Using the second fix, to get "Wor-Wit-End" style.

[DMee]

Nearly there - somethings wrong with

#complex_series

If I cange it to

series_index

it works, but seems to return

__01.00

for even simple 1,2,3 series numbers

also shows as

[ [__01.00] ]

Can we replace _ with space as its in program mode?

[eschwartz]

Originally Posted by DMee

Nearly there - somethings wrong with

#complex_series

What exactly is wrong with it? I cannot think why it wouldn't work, especially as it seemed to work before?

If I cange it to

series_index

it works, but seems to return

__01.00

for even simple 1,2,3 series numbers

That is because #complex_series is supposed to indicate by having content that it should receive the complex formatting. If you test for series_index having content, it will return true whenever there is ANY series_index.

also shows as

[ [__01.00] ]

Can we replace _ with space as its in program mode?

I thought it was supposed to be there on account of spaces will get stripped down to a max of one.

[DMee]

My bad re comples_series - I had forgotten we went for a manual Y/N re complex series

I was thinking of the code

https://www.mobileread.com/forums/sho...&postcount=552

To set the correct format.

I thought the code before the latest tweak took care of leading spaces later on - yours adds brackets and then original adds 2 more brackets later on :-)