Home | Tips | Library | Other Authors | Other WP Sites | Writer's Links | Contact | Site Map | Donate

Barry MacDonnell's
Toolbox for WordPerfect

Macros, tips, and templates for Corel® WordPerfect® for Windows®
© Copyright 1996-2014 by Barry MacDonnell. All Rights Reserved.

Page updated Jan 18, 2014

NoteTools - a suite of macros to help navigate or convert footnotes and endnotes

Jump2FN moves the cursor to a specified footnote so you can edit the note's text. Useful in long, complex documents while reviewing a hard copy.
Jump2Txt moves the cursor from inside a footnote or endnote text to the note's reference number location in the body of the document, and vice versa. (See also LinkNotes below.)
LinkNotes
creates an easy way (using hyperlinks) to quickly jump between a particular footnote or endnote number in the document's body text area to the footnote or endnote text, and vice versa. It is especially useful when you create a PDF file from a document with endnotes or footnotes. See the included LinkNotes-ReadMe.pdf file for more information and examples of the macro's effects.
Note2Txt converts existing footnotes or endnotes to ordinary [but bracketed] text in either the original reference number locations or in a new, separate document. (See Txt2Note, which does the opposite.)
SwapNote converts a single footnote to an endnote, or vice versa.
Txt2Note converts specially bracketed text (editorial notes, etc., [[enclosed in user-defined brackets like this phrase]]) to standard footnotes or endnotes. (See Note2Txt, which does the opposite.)
 

Light bulb
Tips


Blinking green light Download NOTETOOLS.ZIP (01/18/14; 169,155 bytes)

Compatible with WordPerfect 8 and later versions

WordPerfect 11 users: See important information about using macros in the first release of WP11 (11.0.0.233) at the top of this page.

Downloading, Documentation, Modifications, and Support

Related pages:

Did you find something useful here? Did it save you some time?
A small donation -- anonymous if you prefer -- will be greatly appreciated to help me keep this site alive. Donations can be made through your PayPal account or via a secure credit card transaction. Thanks very much for your support!

Jump2FN.wcm (v1.0)

[Part of NoteTools. See download file in the left column.]


Purpose

This is a macro which can take you to a specific footnote's text in a single step so you can edit it.

This might be useful when reviewing a hard copy of a long, complex document and you need to edit a particular footnote in the on-screen document. Since you know the number of the footnote from the hard copy, you can jump to it with this simple macro.

Instructions

Play the macro, enter a footnote number in the pop-up dialog, and click (or press) <Enter>. If the footnote does not exist, a message will be displayed; otherwise, the cursor will jump to the footnote.

To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

[Page top]

Jump2Txt.wcm (v1.0)

[Part of NoteTools. See download file in the left column.]


Purpose

This is a macro that moves the cursor from inside a footnote or an endnote to the note's reference location in the body text area of the document, and vice versa. (This macro is based on the same code as that used in SwapNote, below.)

Instructions

Either place the cursor inside the note or place it immediately after the note's number in the text, then play the macro.

To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

[Page top]

LinkNotes.wcm (v1.04)

[Included in both the NOTETOOLS.ZIP suite above and as a separate download file, LINKNOTES.ZIP (v1.04; 01/18/14; 106,397 bytes).

New in version 1.03 - The macro now works to process documents where note numbers have been reset midway in the document (e.g., new chapters or sections) or where such annotated documents have been concatenated into a single document.]

Purpose

This macro creates "round-trip" hyperlinks to let you quickly jump between a particular footnote or endnote number in a document to the footnote or endnote itself -- and vice versa -- with a mouse click. [N.B.: It is designed to do the entire job for you, so you should not use it with your own manual hyperlinking of footnote or endnote numbers; see the caution below.]

While it is useful to navigate a WPD document during editing, it is especially useful to move around in a long document that has been converted to a PDF file with File, Publish To, PDF.

How it works and how to use it

LinkNotes does this by creating two hypertext links (hyperlinks) — one from the note number in the body text area into the footnote or endnote, and one from the footnote or endnote (via a hyperlinked "return indicator" character or symbol, which you can customize) back to the note's number in the body text area.

Once you play the macro to create the hyperlinks, you can then simply click on a hyperlinked endnote or footnote number in the body text area of your document and you will be transported to the note itself. Once there, you can click on the hyperlinked return indicator (more on this below) and you will be transported back to the note's number in the body text. It's a two-way street, so to speak.

Be sure to read the Comments section below for more infortmation. Note also that certain WordPerfect program settings can impact hyperlink functioning while navigating in WordPerfect [.wpd, .wpt] documents; see "Why some hyperlinks can fail to work...".

Also see LinkNotes-ReadMe.pdf (also included in the download ZIP file) for examples of the macro's effects along with specific information on how it works and how to use it. It also contains notes, caveats, tips and information about changing the hyperlinked "return indicator" character in the notes' text to your own preference.

Comments and caveats

The menu that appears when you play the macro lets you choose between

    • Endnotes (adds hyperlinks to/from them);
    • Footnotes (adds hyperlinks to/from them);
    • Remove all items created by LinkNotes to "clean up" the document.

The third (and optional) choice exists merely to "clean up" a document that was previously processed by LinkNotes by removing its special bookmarks, hyperlinks, and return indicators.

Note that you can always play the macro again (as often as needed) if you

    • insert or delete endnotes or footnotes;
    • use both endnotes and footnotes in the same document.

The linked "return indicator" characters or symbols (you can specify which you want to use: see the .PDF file included with the macro) can be placed either at the beginning or at the end of the notes' text with a checkbox option on the macro's menu.

    • Placing the return indicators at the beginning of a note's text might be more useful if you convert the document to a PDF file since you probably want to transport the viewer to the beginning of the note, not the end of the note (which might span two pages).
    • Placing the return indicators at the end of a note's text might be more useful during the final stages of document editing if your notes are fairly long or they might span pages; in these cases you might prefer to be transported to the end of the note to be able to immediately add material to the note. The choice is simply a matter of personal preference, and as noted above, you can play the macro again and it will re-sequence all hyperlinks with their notes, and re-position the return indicators.

This macro is based on the ideas and code in Jump2Txt.wcm. However, Jump2Txt simply moves the cursor from the note's text to the note's number in the body text area, and vice versa, each time Jump2Txt is played. LinkNotes can jump between any note number that you can click on screen and the corresponding note, and vice versa. That said, Jump2Txt and Jump2FN might be more useful during the document creation process (especially if they are assigned to keys or toolbar buttons) since they do not insert hyperlinks, bookmarks, or return indicators.

Since LinkNotes creates actual links between the note numbers and their notes, the macro is no longer needed after the links have been created unless you revise the document to add or delete notes, or move notes, in which case you should play the macro again. Typically you would first play it on the final draft, then again if endnotes or footnotes are added, deleted or moved.

Caution: You should not have manually hyperlinked endnotes or footnotes before using this macro, or the macro might get confused. If you have already done so, make a back up of the document and remove the [Hyperlink Begin] codes and any adjacent [Bookmark] codes. (Be careful not to remove any of your own hyperlinks or bookmarks. For the latter, the best way is to delete the LinkNotes bookmarks individually in Tools, Bookmarks.) These codes probably will be immediately adjacent to the numbers in the body text area as well as in the notes themselves.

Practical considerations

In general, hyperlinking footnotes probably is not as useful as hyperlinking endnotes since footnotes are usually placed on the same page as the note number. It all depends, of course, on your preferences.

Moreover, creating a hyperlinked PDF file from a document with only footnotes (compared to a document with only endnotes) might cause a slight amount of confusion when a user clicks a footnote number in the PDF file: If the PDF viewer program (Acrobat Reader, Foxit Reader, etc.) is set to display "continuous pages," the current view will be shifted so that the footnote itself appears at the very top of the screen—giving the impression that the overall view has changed to the next page. Similarly, if the PDF viewer program is set to display "single pages" (or similar), clicking a footnote number might leave the view unchanged if both the footnote number and the note are visible on the same screen.

To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

Why some hyperlinks (hypertext links) can fail to work while inside WordPerfect documents (.WPD, .WPT)

See here.

[Page top]

SwapNote.wcm (v1.0)

[Part of NoteTools. See download file in the left column.]


Purpose

This macro is similar to the Corel shipping macros Footend.wcm and Endfoot.wcm, but it allows you to process just one note at a time. Thus, when wrting a draft, you can use just footnotes, and then later convert specific footnotes to endnotes according to your publishing guidelines.

Instructions

Either place the cursor inside the note to be swapped, or place it immediately after the note's number in the text, then play the macro. The note will be converted "in place" -- that is, the new note will be appropriately numbered according to the footnote (or endnote) sequence in effect at that specific location.

Light bulb
Tips

  • Converting a note by first placing the cursor immediately after the note's number in the document's body text may be faster in long, complex documents than placing the cursor inside a footnote or endnote. The latter requires the macro to exit the note and search the document for its text number by examining each note; the former method simply copies the contents of the adjacent note, deletes the note, and then pastes the contents into a new note (of the other type) at the same location in the text.
  • When using both footnotes and endnotes in the same document you may want to change their numbering styles in the body text so that readers can distinguish a footnote from an endnote. For help with this see "Footnotes and Endnotes: Setting or changing margins, numbers, font sizes and other formatting...." One simple way to do this is to enclose footnote (or endnote) numbers in the document's body text in parentheses, and use another style for the other type of note's numbers, such as the default note style, square bracketed numbers, etc.
  • To place endnotes at the end of each chapter, subdocument or other section instead of at the very end of the document, click here.
  • Macro operation: You can display or suppress the first and last message dialog, or set the method used to paste a note's contents in the macro code's User Modification Area. Just open the macro like any other WordPerfect document and read the comments at the top of the code.
  • To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

Known limitations

This macro will not convert an endnote inside a table to a footnote if the table row has been set to span pages (e.g., on the table property bar, click Table, Format, Row, "Divide row across pages"). This is a limitation in WordPerfect, not this macro.

[Page top]

Note2Txt (v1.13)

[Part of NoteTools. See download file in the left column.]


Purpose

Note2Txt.wcm ("Notes to text") is a macro that converta existing Footnotes or Endnotes (and their note numbers) to ordinary text, either at the original location of each note -or- in a new, separate document. 

This makes them more easily transferable to another word processor, or to conform to a publisher's requirements.

You can also use it to place notes "in line" with their text for use while editing a draft of the document, or create a separate list of existing notes, etc.

If an existing note contains no alphanumeric characters or symbols, the macro will insert the phrase "<< empty note in original document >>" in bold, redlined text in the text version of the note. (This can be toggled off in the macro's User Modification Area near the top of the macro's code.)

[Version 1.13 (May 2013) has several code improvements.]

Instructions

Make a backup of the document, then simply play the macro. A menu [screen shot] will pop up with several options.

The converted notes can be placed in either -

    • the original location of the note numbers in the document, or
    • in a new, separate document. Placing them in a new, separate document means they can be formatted, copied to another location such as the end of individual chapters, etc. This also makes them more easily transferable to another word processor, or to conform to a publisher's requirements.

Normally, the note numbers (which are actually codes) in the body text area of the document are deleted, but a menu option lets you insert text numbers (only) back into the original document if the notes' content was converted to a separate document. The text numbers can be superscripted or bracketed. This should make it easy to convert the document to a publisher's format requirements (e.g., all notes at the end of the document and all note numbers entered as ordinary text characters, not WP codes).

You also have the choice of text formatting for the converted note's text: (1) unformatted ("plain text"), (2) formatted (retain text attributes such as bold, italics, etc.). You may want to experiment to see which choice is best for you.

After the macro has finished processing the document, if you have chosen to place the notes in a separate document it will display a dialog that gives you a few final options:

    • Restore (undo changes) to your original document;
    • Re-number notes where they were in the original document (e.g., in ordinary superscript numbers), for your reference (you can save the document with a different name); or
    • Leave original document alone (i.e., with no notes or note numbers).

Light bulb
Tips and Cautions

  • Always make a backup of your document before playing this macro on the document.
  • Because this macro requires strictly sequential arabic numbers for notes, any changes you have made in note number type (e.g., letters or Roman numerals), starting number, numbering sequence, or endnote placement will be removed from the document. The resulting text version of each note will be numbered 1,2,3... to the last footnote or endnote.
  • Bookmarks (including QuickMarks) that are located inside footnotes and endnotes will be lost when the notes are converted to text. This is due to the way bookmarks work when they are cut from a document and pasted into another location. However, index codes and comments inside footnotes and endnotes are not affected.
  • See also the author's Txt2Note.wcm ("Text to Notes"), which is a WordPerfect 8+ macro to convert previously marked ("bracketed") text to Footnotes or Endnotes. It is especially useful after playing the current macro, Note2Txt.wcm ("Notes to Text"), and you wish to convert the (possibly edited) text in the current document back to Footnotes or Endnotes.
  • Menu defaults can be changed in the User Modification Area of the macro code.
  • To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

Light bulb
Tips for ENDNOTE users

  • For very large documents with many endnotes, the macro can take a long time to complete. Test the macro first on a small portion to see what the menu selections accomplish.
  • If you use the master/subdocument feature, you may want to run the macro on each subdocument individually.
  • Do you need to place endnotes at a specific location other than the default location (which is at the very end of all pages)?
    • For example, suppose you want to add materials such as tables, figures, or a bibliography after all endnotes. You can anchor endnotes at a specific spot by placing your cursor at the end of the section where you want endnotes to appear and click Insert, Footnote/Endnote; enable the Endnote button, then click Endnote Placement, Insert endnotes at insertion point. You can insert a page break before the endnotes so that they display on a separate page. For more help, see "Creating Endnotes" in WP's online help (F1) index.
  • Do you want an index to refer to the pages where the endnotes are located instead of the pages where the endnote numbers appear? This can be done using Note2Txt:
    • Make a backup of the document.
    • Convert all endnotes to text in a separate document with Note2Txt, like this:
      • When you play Note2Txt, choose the "separate document" option on the first menu that appears;
      • delete the two bracket characters on the second menu and make any other format changes there such as using a period/full stop after the number;
      • choose the second radio button ("Number notes where they were in the original document") on the third menu (i.e., the menu entitled "Conversions Complete" that appears at the very end of the macro's execution).
    • The endnotes should now be found in a separate document as ordinary text, not inside an endnote substructure.
    • Copy and paste the notes from the separate document back into the original document, to the appropriate page(s) where the endnotes should be located.
    • Place the cursor where the index should be located, and invoke the Index feature using the concordance file. This should index the document and the endnotes properly. (It did for me in a test I just conducted.)
    • Be aware that this process removes endnotes from the original document, so it is best to do it after the final draft of the document. Otherwise, and change in the pages because of reformatting, adding/deleting endnotes, etc., will throw the index's pagination off.
  • If you use File, Publish To, HTML in recent versions of WordPerfect, hyperlinked endnotes will show up in the resulting HTML document only if "Plain HTML" is chosen under Publish Options. Otherwise they will appear as comments. [Thanks to Derek Duke on WordPerfect universe for this tip.]

Known Limitations

  • The macro does not process items inside headers, footers, footnotes, endnotes, or text boxes. For example, WordPerfect won't let you convert material inside a footnote into a footnote (which would be a "nested" footnote), so the macro does not search for items inside such "substructures."
  • WordPerfect does not support footnotes in parallel columns. However, footnotes can be created in newspaper columns. You can change parallel columns to newspaper columns by double-clicking the [Col Def] code in Reveal Codes.
  • WordPerfect does not support footnotes in Header rows in a table. However, you can use Endnotes in a Header row.

You should examine the document and make any required changes in these areas by directly editing them.

Updated: v1.12 (01/11/08) - Minor fix to 'Please Wait' routine for Vista compatibility.

[Page top]

Txt2Note (v 1.01)

[Part of NoteTools. See download file in the left column.]


Purpose

Txt2Note.wcm ("Text to notes") is a macro that converts specially bracketed your text notes or other annotations in a document to footnotes or endnotes. (Txt2Note is similar to CONVERTR.)

Instructions

Simply play the macro; a menu will pop up with several options.

The macro searches for material that is bracketed by user-defined text markers. It then either (1) discards the markers and converts the material into footnotes, endnotes, regular body text, or italicized text, or it (2) deletes the marked material (both text and markers).

The macro can remove or convert the marked text in one operation, or, if you check the menu's "Prompt..." box (the default), it can pause and wait for user confirmation of each instance found. Using the Prompt option and playing the macro multiple times with different conversion options allows you to choose exactly what to do with individually marked draft text.

Examples

After playing the macro, if the document contained some text like this:
... the sample <<<of our new product>>> is enclosed ...

...and you chose the option to delete it, the result will look like this:
... the sample is enclosed ...

[i.e., text and left/right bracket markers are deleted]

...or you chose to convert it to normal text, it will appear like this -
... the sample of our new product is enclosed ...

[i.e., left/right bracket markers deleted; text is converted to normal body text]

... or you chose the option to convert it to a footnote (the default), it will appear like this -
... the sample1 is enclosed ...

[with the text -- "of our new product" -- is inserted as a footnote on the page]

Light bulb
Tips and Cautions

  • Beginning and ending markers must be different. Marking text @like this@ will not work. Marking text [FN like this] or [[like this]] or <@like this@> will work as long as these markers are not present elsewhere in the document.
  • If you used single brackets [ ] or parentheses ( ) to mark text, you may want to use the "Prompt user for confirmation" option from the main menu, so that you will not inadvertantly delete or convert text that should be bracketed or should be in parentheses.
  • Using the same marker symbol inconsistently in the same document may produce unexpected results. E.g., Using both "<< >>" and "< >" marker pairs in the same document -- especially if they are "nested" -- may cause the macro to fail to select the enclosed text properly. (Playing the macro using the "Prompt..." option will usually uncover the problem area.)
  • This macro will not convert text in a separate document back to footnotes or endnotes. If you used the author's Note2Txt macro and chose to place the converted material in a separate document, reversing the procedure cannot be done with Txt2Note. The marked text must exist in the current document in previous footnote/endnote locations. This macro can convert such text to notes, but it cannot make judgments on where text from another document should be placed.
  • Remember that any changes to the document can usually be reversed with Edit> Undo after the macro plays. When in doubt, or until you are familiar with the macro, play it on a copy of the document.
  • To assign this macro to a menu, keystroke, or toolbar for quick and easy access, see here.

[Page top]