hyperlink endnotes

[rjwse@aol.com]

A new feature in calibre lets you produce hyperlinks with a saved template. I have searched the user documentation of calibre and have not seen a tutorial to this. I am confused on how to use this. I would be grateful if someone could provide detailed instructions how to make use of this. I cannot understand the far-right panel "choose a location (anchor) in the file" nor how to set up in general. Best regards, Pop

[kovidgoyal]

You pick a file on the left, the right panel gets populated with all linkable locations in the file (anchors), you pick one and calibre will insert the link for you. If there are no linkable locations in the destination file, then the right list will beblank.

[Tex2002ans]

Originally Posted by rjwse@aol.com

I cannot understand the far-right panel "choose a location (anchor) in the file" nor how to set up in general.

Example. Let's say you want to create a link that jumps to a specific location in the book.

The way you achieve this is to give parts of your book a unique name. In HTML, this is called an "id" anchor.

Chapter02.xhtml:

<h2 id="HeadingCh2-2">This is Heading 2</h2>

This is the important information you need:

• It's located in file Chapter02.xhtml
• Has an id of HeadingCh2-2

Now let's say elsewhere in your book, you wanted to create a link that jumps to this location.

<p>This is a link to Chapter 2, Heading 2.</p>

First, you select whatever text you want to link:

<p>This is a link to Chapter 2, Heading 2.</p>

Then you push the Insert Hyperlink button (looks like a chain).

Now you want to tell it where to link to.

The Insert Hyperlink Screen



On the left-hand side, you have a list of Files. Select which one you want the link to jump to (in this case, Chapter02.xhtml).

(Optional) On the right-hand side, you'll see all the "id"s in that file. So it will display all "id"s located in Chapter02.xhtml. Like Kovid said, if no "id"s exist, this side can be completely blank.

Scroll down and select the one you want to jump to.

This will prepopulate all the bottom boxes for you.

After

Once you push OK, Calibre will convert your previous code

<p>This is a link to Chapter 2, Heading 2.</p>

into:

<p>I want this to point to <a href="Chapter02.xhtml#HeadingCh2-2">Chapter 2, Heading 2</a>.</p>

This is an <a> tag. In HTML, <a> is used for links.

Now you can see all your important information located within the link:

<p>I want this to point to <a href="Chapter02.xhtml#HeadingCh2-2">Chapter 2, Heading 2</a>.</p>

• Red tells you the link will jump to Chapter02.xhtml.
  • This is what you selected in the left-side box.
• (Optional) Blue tells you the link will jump to the id HeadingCh2-2.
  • This is what you selected in the right-side box.

[thiago.eec]

Originally Posted by rjwse@aol.com

A new feature in calibre lets you produce hyperlinks with a saved template. I have searched the user documentation of calibre and have not seen a tutorial to this. I am confused on how to use this. I would be grateful if someone could provide detailed instructions how to make use of this. I cannot understand the far-right panel "choose a location (anchor) in the file" nor how to set up in general. Best regards, Pop

I guess you are interested on the the Template feature, right?
Since your post title is about endnotes, let me give you an example:

Take a look at this normal text inside a chapter:

<p>This is a normal text with an endnote reference1</p>

Supose your reference is the number "1" left in there:

1. Select the text you want to be your clickable link (in this case: "1")
2. Click on the button "Insert Hyperlink"
3. On the new window, choose the file you will link to and its anchor (see @Tex2002ans detailed explanation above)
4. Now, on the template field, you must create a pattern that will be repeatable for all you hyperlinks

Since you want to format endnotes, here is an example of a template for an endnote on a EPUB3 file:

<a href="_TARGET_" class="notes" epub:type="noteref" role="doc-noteref" title="Endnote reference" id="noteref__TEXT_">_TEXT_</a>

Every link will have this structure, so you don't have to repeat it everytime. This is just an example and you can change it to fit your needs.

The only thing I suggest is not to use <sup> on you code. Use css 'vertical-align' instead:

a.notes {
   vertical-align: super;
   line-height: normal;
   font-size: smaller;
}

[phossler]

I think it'd be helpful if there were a _FILENAME_ placeholder similar to _TARGET_ and _TEXT_ since the_TEXT_ parameter (1, 2, 3, …) might be used in more that one file

I believe that having the option to create the id like this would make it much easier when the user adds the 'back to' link in the end notes

So in chap_01.xhtml when inserting a hyperlink using the template

<p>text text text more text<a id="chap_01_noteref_.1." href="endnotes.xhtml#endnote_chap_01_.1.">[1]</a> some more text</p>
<p>text text text more text<a id="chap_01_noteref_.2." href="endnotes.xhtml#endnote_chap_01_.2.">[2]</a> some more text</p>
<p>text text text more text<a id="chap_01_noteref_.3." href="endnotes.xhtml#endnote_chap_01_.3.">[3]</a> some more text</p>

and in chap_02.xhtml

<p>text text text more text<a id="chap_02_noteref_.1." href="endnotes.xhtml#endnote_chap_02_.1.">[1]</a> some more text</p>
<p>text text text more text<a id="chap_02_noteref_.2." href="endnotes.xhtml#endnote_chap_02_.2.">[2]</a> some more text</p>
<p>text text text more text<a id="chap_02_noteref_.3." href="endnotes.xhtml#endnote_chap_02_.3.">[3]</a> some more text</p>

Seems like it would make it easier when generating the 'back to' in Endnotes

<p><a id="endnote_chap_01_.1." href="chap_01.xhtml#chap_01_noteref_.1.">[1]</a> - Footnote One in Chapter 1</p>
  <p><a id="endnote_chap_01_.2." href="chap_01.xhtml#chap_01_noteref_.2.">[2]</a> - Footnote Two in Chapter 1</p>
  <p><a id="endnote_chap_01_.3." href="chap_01.xhtml#chap_01_noteref_.3.">[3]</a> - Footnote Three in Chapter 1</p>

  <p><a id="endnote_chap_02_.1." href="chap_02.xhtml#chap_02_noteref_.1.">[1]</a> - Footnote One in Chapter 2</p>
  <p><a id="endnote_chap_02_.2." href="chap_02.xhtml#chap_02_noteref_.2.">[2]</a> - Footnote Two in Chapter 2</p>
  <p><a id="endnote_chap_02_.3." href="chap_02.xhtml#chap_02_noteref_.3.">[3]</a> - Footnote Three in Chapter 2</p>

[thiago.eec]

Originally Posted by phossler

I think it'd be helpful if there were a _FILENAME_ placeholder similar to _TARGET_ and _TEXT_ since the_TEXT_ parameter (1, 2, 3, …) might be used in more that one file

I believe that having the option to create the id like this would make it much easier when the user adds the 'back to' link in the end notes

I agree. It could be handy to have variables for both the target and the file being edit. Something like _TARGET_FILENAME_ and _CURRENT_FILENAME_.

Also, it would be great to SAVE those templates. So we could select then from a drop-down menu, or maybe using code snippets (ctrl+j, on Windows). This way we could have various templates for diferent situations: footnote/endnote reference, footnote/endnote backlink, links to external resources, etc.

[phossler]

Originally Posted by thiago.eec

I agree. It could be handy to have variables for both the target and the file being edit. Something like _TARGET_FILENAME_ and _CURRENT_FILENAME_.

Maybe _THISFILE_ and _REFFILE_


Shorter

[kovidgoyal]

sure easy to add.

[jbacelar]

Originally Posted by kovidgoyal

sure easy to add.

[thiago.eec]

Originally Posted by kovidgoyal

sure easy to add.

Thanks, Kovid!

Will you add the option to save the templates too? That would be awesome.

[kovidgoyal]

there's no option to save but the field has a drop down with recently used templates

[thiago.eec]

Originally Posted by kovidgoyal

there's no option to save but the field has a drop down with recently used templates

I am using version 3.37 (x64) on a Windows 10 system. For me, there is no dropdown list.

[kovidgoyal]

yes because it will be in the next release.

[thiago.eec]

Originally Posted by kovidgoyal

yes because it will be in the next release.

Oh, right. I thought you are talking about the current state of this feature.

Thank you for this!

[phossler]

Originally Posted by kovidgoyal

sure easy to add.

Thanks

This will greatly help putting in 'both ways' hyperlinks

Text --> Note --> Text