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

[eschwartz]

Originally Posted by 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 :-)

Whoopsie.

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')
); 


If we are using chaley's script, it's even easier. Just plug in "#complex_series" as the actual value of 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.
#
#       s_index is now a manually set value using field "#complex_series"
s_index = field('#complex_series');

#       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')
); 


[chaley]

FWIW: the complexity of this is starting to call for a custom template function.

I have somewhere a python script that scans the database, computes the minimum format to represent the largest series numbers and the minimum number of fractional digits, and stores the format in a custom column. I can post it tomorrow if anyone is interested and if I can find it.

[eschwartz]

Do you mean the one linked from post #585?

[chaley]

Originally Posted by eschwartz

Do you mean the one linked from post #585?

Yes.

[DMee]

Originally Posted by chaley

Yes.

I just tried running the code

I copied and pasted to a file I called complex-series.txt and saved in my user directory

I then ran

calibre-debug -e complex-series.txt

It did nothing for a few minutes and then I was back at command line

I opened calibre but couldn't spot anything new anywhere

i) am I doing it right?
ii) is that the full code you posted
iii) where should data end up?

[chaley]

Originally Posted by DMee

I just tried running the code

I copied and pasted to a file I called complex-series.txt and saved in my user directory

I then ran

calibre-debug -e complex-series.txt

It did nothing for a few minutes and then I was back at command line

I opened calibre but couldn't spot anything new anywhere

i) am I doing it right?
ii) is that the full code you posted
iii) where should data end up?

You must change two things in the script:
1) change line 12 so that 'path-to-your-library' is the real path to your library.
2) change '#text' on line 34 to a lookup name of a text-type (not tags) custom column in your library.

After you run the script you should see the number format in the text column for books with a series, similar to the screen capture below. You would use that format in the template when you generate series strings.

[DMee]

Now where's the blush icon......

Cheers :-)

[DMee]

OK, chaley's script ran fine - eventually

But produces

Leg-of-Eli-Mon [{0:01.0f}] The Spirit Thief

when plugged into scrip??

[chaley]

Originally Posted by DMee

OK, chaley's script ran fine - eventually

But produces

Leg-of-Eli-Mon [{0:01.0f}] The Spirit Thief

when plugged into scrip??

The script produces a number format string, not a formatted series number. I think you want

s_index = format_number(field('series_index'), field('#complex_series'));

[eschwartz]

Originally Posted by chaley

The script produces a number format string, not a formatted series number.

Really? Why doesn't it just have the formatted number?
I jumped to the assumption that your script would produce the actual number, it seemed like a more obvious result.

[chaley]

Originally Posted by eschwartz

Really? Why doesn't it just have the formatted number?
I jumped to the assumption that your script would produce the actual number, it seemed like a more obvious result.

Because that would require writing every book with a different value, meaning a transaction per book in series. As it is, I use the write_many API so there is a transaction per series. I wanted the script to be as fast as possible, and didn't care about any extra work to use the format.

The scheme permits you to copy the format instead of running the script if you know that the existing format is correct. It also permits you to change the format manually in one bulk edit if you change the series structure for a book.

Feel free to change it if you want.

[eschwartz]

Ah, Okay. That makes sense. I like your way.

I just didn't realize at first what you were doing.

[DMee]

Chaley

I tried to be clever and amend your code so it produces {_>7.2f}

which I thought would replicate the

{series_index:_>7.2f}

I used to use

but it doesn't work.......

[chaley]

Originally Posted by DMee

Chaley

I tried to be clever and amend your code so it produces {_>7.2f}

which I thought would replicate the

{series_index:_>7.2f}

I used to use

but it doesn't work.......

It should be

{0:_>7.2f}

[crissman]

Now that I have been able to configure the plugboards for specific outputs with all your excellent help, I was wondering how to create a regex in search and replace to clean up the title fields in my library.
I would like to remove the series and series_index from the title field:
Examples I have found in the library are:

The Alexander Cipher - Daniel Knox [1]

Hidden Empire: The Saga of Seven Suns, Book 1

The Alexandria Link - Cotton Malone - 2

I would like to strip this down to the title alone and completely remove the series and series numbers

Also there are a few entries that have other info that I would like to remove such as the ": A Novel"

The Charlemagne Pursuit: A Novel
but keeping in mind that there are titles that have the colon and extra title information that I would like to keep like:

The Balkan Escape: A Cassiopeia Vitt Adventure - Cotton Malone [5.50]

and the extra dashes from the title:

The Amber Room - -

I have colored the parts that I would like to remove

Thanks
crissman