Making an index?

nontroppo · May 9, 2024, 1:14am

I’ve created a Pandoc filter that basically does what @AmberV’s compile replacements do for ODT, but with the added flexibility of supporting Typst + ODT + DOCX + LaTeX. It depends on the same two styles AmberV specifies: Index Key and Index Term — these should get compiled to \index{ancestor!parent!keyword} and \indext{ancestor!parent!keyword} (you need to wire these up in your compile format); the ancestor and parent are optional. The difference between \index and \indext are based on whether you want the term to be retained in the text. So if you write This [term] here. with [term] being an Index Term style, the output in e.g. Typst would be: This term #index[Term] here. with output like This term here. i.e. it adds the term to the text and uses a title case of the same word for the index. Using Index Key you’d get This #index[Term] here. and the output text would be This here.

github.com

iandol/dotpandoc/blob/master/filters/convertIndex.lua

--[[
	convertIndex.lua: parse \index{item} for marking up words for an index
	for ODT, DOCX, Typst & LaTeX native output. 
	
	You can use \index{Ancestor:Parent:item} to mark up an index item with
	an ancestor, parent and item. {note: DOCX only supports Parent:item}

	You can use a cross-reference: \index{item|see{term1, term2}}

	For ODT and TYPST you can make a main index entry page number (bolded) 
	by using a leading asterisk: \index{*item}.
	
	You can use a custom tag \indext{item} to include the term itself in the
	text. This makes writing easier as you can markup words directly. For
	example "This falls \indext{here}." will become "This falls
	here#index[Here]." for Typst output.
	
	For ODT or DOCX it uses the native XML markup for index items.
	
	For Typst, you'll need https://typst.app/universe/package/in-dexter

This file has been truncated. show original

For outputs other than ODT / Typst / LaTeX the filter will retain \indext terms and remove \index terms from the text, so this should play nicely with any of the zillion outputs Pandoc supports from Scrivener… LaTeX itself offers more complex options, but as these are not clearly supported by other output engines I didn’t implement them… The filter could also support DOCX [EDIT: now it does], but the XML is so fussy and annoying to work with (as @amberV mentioned), also Libreoffice has a nicer UI for editing index entries IMO…

EDIT: V1.06 of the filter also supports DOCX output