I don't know if it is better approach that the one from that StackExchange answer. Some other stuff to consider that must work if I re-work the whole footnote cross-referencing mechanism:
- I use cross-references for other stuff too, not just for the footnote cross-references. What you suggest should not interfere with any other cross-reference.
- I work with InDesign books (INDB file format), therefore it must use the _Start At_ number from the Footnote Options as the the first footnote reference number.
- The footnote reference number must auto-update whenever another footnote before it is inserted or removed.
---
Anyway, here's the current version of the script based on the StackExchange answer (it might not be perfect, but it works):
// Sidenotes preparation + update script
// author: Tukusej's Sirs
// licence: GNU GPLv3
// date: 2 May 2020
// version: 1.0
// Presumptions:
// - If `paraStyleSidenotesName` paragraph style exists, the bulleting is set the way the user wants (i.e. this script does not modify it unless `footnotesStartAt` is modified (and then only `numberingStartAt` is modified)).
// - Each footnote reference in the document (but not in the footnotes) is not allowed to be followed by any other type of anchored object but the one we insert.
// Algorithm source: https://graphicdesign.stackexchange.com/a/129868/133961
// Other sites that helped me:
// - https://community.adobe.com/t5/indesign/how-to-format-the-numbering-number-in-a-paragraph-style-via-script/m-p/11095225#M184568
// TODO
// - does not work if a footnote is at the end of the document (workaround: additional search for `~F$`, but that also matches other footnotes at the end of the paragraph);
// - auto-update the inserted/removed footnotes;
// - auto-update the changed Start At footnote number in the _Sidenote_ paragraph style;
// Variables
var paraStyleSidenotesName = 'Sidenotes';
var objStyleSidenotesName = 'Sidenotes';
var numberingNumberFormat = '^#';
var objStyleXOffset = '20'; // Horizontal offset from page edge; in millimeters (or rather based on preferences? IDK)
var objStyleYOffset = '-5'; // Vertical offset from baseline; in millimeters (or rather based on preferences? IDK)
var textFrameHeight = 6;
var textFrameWidth = 13;
var textFrameText = ' '; // Note: The frame has to contain at least a character, else the numbering number won't show up; A space won't show up in the inserted cross-reference
var doc = app.activeDocument;
var footnotesStartAt = doc.footnoteOptions.startAt; // Get the footnote `Start At` number
var paraStyleSidenotes = doc.paragraphStyles.itemByName(paraStyleSidenotesName);
var objStyleSidenotes = doc.objectStyles.itemByName(objStyleSidenotesName);
// Create `paraStyleSidenotesName` paragraph style if missing
// Note: If a paragraph style with `paraStyleSidenotesName` already exists, it is not modified unless `footnotesStartAt` is modified (and then only `numberingStartAt` is modified)
if (paraStyleSidenotes.isValid) {
if (paraStyleSidenotes.numberingStartAt != footnotesStartAt) {
paraStyleSidenotes.numberingStartAt = footnotesStartAt;
}
} else {
var newStyle = app.documents[0].paragraphStyles.add(
{
name: paraStyleSidenotesName,
bulletsAndNumberingListType: ListType.NUMBERED_LIST,
numberingFormat: NumberingStyle.ARABIC,
numberingExpression: numberingNumberFormat,
numberingStartAt: footnotesStartAt
}
);
}
// Create `objStyleSidenotes` object style if missing
// Note: If a object style with `objStyleSidenotesName` already exists, it is not modified
if (! objStyleSidenotes.isValid) {
var newStyle = app.documents[0].objectStyles.add(
{
name: objStyleSidenotesName,
enableFill: false,
enableFrameFittingOptions: false,
enableExportTagging: false,
enableObjectExportAltTextOptions: false,
enableObjectExportEpubOptions: false,
enableObjectExportTaggedPdfOptions: false,
enableStoryOptions: false,
// enableStroke: true,
enableStrokeAndCornerOptions: false,
enableTextFrameBaselineOptions: false,
enableTextFrameFootnoteOptions: false,
enableTextFrameGeneralOptions: false,
enableTextWrapAndOthers: false,
enableTransformAttributes: false,
enableParagraphStyle: true,
enableAnchoredObjectOptions: true,
enableTextFrameAutoSizingOptions: true,
appliedParagraphStyle: paraStyleSidenotes,
strokeWeight: 0,
anchoredObjectSettings: {
anchoredPosition: AnchorPosition.ANCHORED,
spineRelative: true,
anchorPoint: AnchorPoint.TOP_RIGHT_ANCHOR,
verticalReferencePoint: VerticallyRelativeTo.LINE_BASELINE,
verticalAlignment: VerticalAlignment.TOP_ALIGN,
horizontalReferencePoint: AnchoredRelativeTo.PAGE_EDGE,
horizontalAlignment: HorizontalAlignment.LEFT_ALIGN,
anchorXoffset: objStyleXOffset,
anchorYoffset: objStyleYOffset,
pinPosition: false
},
textFramePreferences: {
autoSizingType: AutoSizingTypeEnum.HEIGHT_AND_WIDTH,
useMinimumHeightForAutoSizing: true,
useMinimumWidthForAutoSizing: true,
minimumHeightForAutoSizing: textFrameHeight,
minimumWidthForAutoSizing: textFrameWidth,
useNoLineBreaksForAutoSizing: true,
nonprinting: true
}
}
);
}
// Insert a text frame object
var textFrame = doc.pages[0].textFrames.add();
textFrame.properties = {
appliedObjectStyle: objStyleSidenotes,
contents: textFrameText // Note: The frame has to contain at least a character, else the numbering number won't show up; A space won't show up in the inserted cross-reference
};
// Clear the selection
app.select(null);
// Select the textFrame
doc.select(textFrame);
// Cut the text frame
app.cut();
// Reset the GREP preferences
app.findGrepPreferences = NothingEnum.NOTHING;
app.changeGrepPreferences = NothingEnum.NOTHING;
app.findGrepPreferences = null;
app.changeGrepPreferences = null;
app.findChangeGrepOptions.properties = (
{
includeFootnotes: false,
includeMasterPages: false,
includeHiddenLayers: false,
includeLockedLayersForFind: false,
includeLockedStoriesForFind: false,
}
);
// Set the GREP search preferences for search footnote references that are not followed by an anchored object
app.findGrepPreferences.findWhat = '~F\\K[^~a]';
// app.findGrepPreferences.findWhat = '~F\\K([^~a]|$)';
app.changeGrepPreferences.properties = (
{
changeTo: '~c$0'
}
);
app.findGrep();
doc.changeGrep();
// Set the GREP search preferences for search footnote references are at the end of a paragraph
// Note: This is used only for the footnote reference at the end of the document as footnote references at the end of paragraph but the last paragraph of the document are matched by the previous GREP search
// Note: This one places the anchored object _before_ the footnote references and thus creates a (potential) bug when the user inserts additional text either at the end of the last paragraph or a new paragraph after the last paragraph
app.findGrepPreferences.findWhat = '~F$';
app.changeGrepPreferences.properties = (
{
changeTo: '~c$0'
}
);
app.findGrep();
doc.changeGrep();
10
Replies
AdChoices