FMnotes - FrameMaker Footnote enhanced, Convert to Endnotes, Create Sidenote

FMnotes is an ExtendScript package expanding FM's footnote function:

• Enhance Footnotes: add hyperlink function to the footnote reference.
• Convert to Endnotes: convert footnotes to a single location at the end of current document – or for books in a distinct document.
• Insert Sidenote: create a side note box ready to write into it.
• The installation and the script adapts its UI language to the FM-UI-language (de, en, fr).
  L'interface utilisateur française a été créée avec le service web DeppL (https://www.deepl.com/translator).
• Functions are available as menu entries or ESC sequences.
• Tested with FM-15 (2019).

Note: This page does not describe all features of FMnotes. See the full documentation (pdf).

Enhance Footnotes
Convert Footnotes to Endnotes
Create Sidenote
Downloading and installing FMnotes

Side Note: If you are looking for sophisticated footnote functions, such as

• Table footnotes appearing on the same page as the reference in the table (that is, not at the end of the table)
• Foot note references with special formats, e.g. (*)

… get in contact with Jang F.M. Graat. He makes FrameMaker jump through hoops [2019-11-16].

Enhance Footnotes

• Enhance Footnotes acts on all footnotes, that is also on table footnotes and footnotes in text frames which are in an anchored frame.
• This functions works in a single document as well as for all documents of a book.
• The footnote reference gets an additional cross reference function. This is very handy when not the whole page is visible at once. It is also important for footnotes which are not on the same page as the reference.
• Cross reference format zfnref‐footnote‐reference and character formats super and hypertext are default names. This can be changed in global settings.
• Default presentation of the cross reference is the ellipsis (…) in front of the footnote reference.
• The names of cross reference formats and also the highlight for the foot note reference (FM default is super) can be defined. FMnotes proposes fn_ref_format: superscripting, colour blue to indicate the link function.

Note: The installation provides keyboard shortcuts for command GoToPrevView: ESC ← and GoToNextView: ESC →
The same shortcuts as in Acrobat (ALT+ ←, ALT+→) would delete the function to nudge graphic objects by one pixel.

Convert Footnotes to Endnotes

• Convert to Endnotes acts only on ordinary footnotes, not on table footnotes and footnotes in text frames which are in an anchored frame.
• The function replaces the footnote reference by a cross reference to the corresponding endnote.
• For a single document the footnotes are collectively converted to endnotes at the end of the current document. For a book all footnotes from the book files are converted into endnotes in a new book file named endnotes.
• Since footnotes may consist of multiple paragraphs, there are two ¶ formats for endnotes: zen‐endnote and zenc‐endnote‐continue. For the list heading ¶ format zent‐endnote‐title is used.
• Character formats super and hypertext are default names used in the cross reference format zenref‐endnote‐reference. The default appearance of the cross reference is a blank to both sides of the endnote-number.
• After composing an additional endnote you can go back to the insertion point by function Back to insert point (which then is a cross reference to the new endnote).

Attention: After converting the footnotes to endnotes do not use the original footnote mechanism any more, but the menu item Insert Endnote. You may of course use the footnote mechanism as an alternative apparatus.

Create Sidenote

A side note is a marginal note at the outer margin of the individual pages of a book, especially in the case of scientific works. In the manner of running titles, they are intended to indicate the content of individual text passages, paragraphs or pages.

• Insert Sidenote creates an anchored frame outside of the text frame with a text frame in it which will receive the text of the note.
• AFter creation the cursor is in the text frame and the user can type the note immediately.
• The placement can be in the larger margin or the inner or outer margin.
• The text frame may be filled with a background colour.
• Default pargraph format for the note text is zsn‐side‐note defived from Body, with font size 8pt.

Downloading and installing FMnotes

Note: All software from D+DD is Donationware - if you find it helpful for your work, think about supporting also my work.

1. Download the installation file

FM version	Date	Version	Installation file(s)	Latest changes
10 and later	2019-08-28	1.0	Inst-FMnotes.zip	First issue of FMnotes
	2019-09-12	1.1		All necessary default formats created by script Go back and forward in hyper-jumps by ESC ← and ESC →
	2021-01-14	1.2		Correcting wrong OR statements in functions
	2021-05-11	2.0		Localisation now uses XML files. Attention: function "Go back to Insertion Point" after inserting an Endnote does not work (I'm currently to tired/ill to fix this)
	2021-10-27	2.1		Correcting stray global variable bkFMnotesMenu
	2022-04-12	2.2		Already enhanced footnotes are now handled correctly Book function corrected for Enahce Footnotes Documentation changed (new names for formats to avoid conflicts with template defined formats)
	2023-03-08	2.3		Correction: language switching for French was erraneous

2. Before installing a new (updated) version, uninstall the current version: start the installation program from the short cut in the Start-menu > D+DD. Then use the Un-Install button.
3. UnZip the file to the desktop (you get a file and a directory).
4. Execute the file PrepareInstallation.exe.
   
   • The language of the installation dialogues adapts to the UI language of your current FM installation (de, en, fr).
5. The last six FM-versions present in your %appdata%/Adobe/FrameMaker/ are listed in the dialogue (on your system there may be only one).
   
6. Select the FM-version for which you want to install FMgraph.
7. Use Continue Installation. This opens the installation program:
   
   
8. Select the appropriate option(s):
• Use the first option to start the script automatically at FM-start.
• Use the second option if you wish to start the script on demand from a trusted source. You can define the script in File > Scripts … > Catalog (Script Library) as Favourite: use the Add button and navigate to My Documents\Adobe Scripts\FMnotes\FMnotes.jsx.
9. With Install the script and associated files will be transferred into the relevant locations.
   In maker.ini a section D+DD is established.
10. A message indicates the end of the installation. The desktop icons will be removed.

Uninstall the script

To uninstall the script, start the installation program from the short cut in the Start-menu > D+DD; set the option(s) to define what to uninstall; then use the Un-Install button.

You can later use the installation program again.

To get completely rid of the script you need to remove the following in addition to the un-installation:

• The short cut in the start menu
• Directory %appdata%\D+DD\FMnotes

Caveat

Any software from D+DD is provided by the author and contributor "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed.