Skip to content

Refactorings

Refactorings are actions you can take to make a change in your project while letting Zensical Studio help you ensure that links and other references remain intact.

Rename headings

One of the recurring problems in technical writing is that renaming a heading breaks existing links to that heading. With Zensical Studio, you can rename a heading with Rename SymbolRename SymbolRenameRenameF2. You can right-click on a heading and select from the context menu or use the keyboard shortcut.

renaming a header changes links

Zensical Studio will update any links to the heading for you. This way, you never create broken references.

Headings with IDs

Note that if you assign a manual ID to a heading, you can no longer rename it with F2. See below.

Renaming reference labels

Place your cursor on either the definition ([ref]: ...) or any use ([text][ref]), trigger rename, and every occurrence of that label throughout the file is updated together.

renaming a reference label makes changes to all links using it

Rename or move files

If you need to rename or move a file in the ExplorerExplorerProject panelProject tool window, Zensical Studio will also update all links to this file, ensuring that they remain intact.

when you move a file, Zensical Studio updates links to it

Rename footnotes

You can also rename footnotes. This affects the label, which is also the anchor for the footnote. In the example below, #fn:1 becomes #fn:explain.

renaming a footnote

Rename abbreviations

When you rename an abbreviation, you change not just a label but instead change all occurrences of the abbreviation in your project. The example below shows an example where SSL is replaced with TLS, its modern successor standard.

replacing SSL with TLS across your entire documentation