Hello,
I will work with USFM (Unified Standard Format Markers) in Atlantis and I would like to ask about possible support for two related features: syntax highlighting and automatic insertion of USFM markers.
About 10% of my text already contains USFM markers, so for that part I mainly need syntax highlighting - ideally, all markers beginning with a backslash (e.g., \v, \c, \p, \h, custom markers like \cs, etc.) would be highlighted in a distinct color or style. Line‑initial markers are relatively easy to target with regex‑like rules, but I have not found a way to highlight all markers consistently throughout the document.
For the remaining 90% of the text, it would be extremely helpful to have automatic assistance when inserting => USFM markers, combined with the same highlighting. Simple markers that start a line are manageable, but more complex paired markers - for example: - \f ... \f*, - \it ... \it*, - \sls ... \sls* - are much harder to handle manually. Ideally, Atlantis would allow defining snippets, auto‑completion rules, or another mechanism that inserts both the opening and closing marker automatically, placing the cursor between them.
If Atlantis already provides a way to configure this, I would appreciate any guidance. If not, I would be grateful to know whether such features could be considered for future versions, as they would significantly improve workflows for users working with structured text formats like USFM.
Thank you very much for your help.
Jerzy
Support for USFM syntax highlighting and automatic marker insertion
Re: Support for USFM syntax highlighting and automatic marker insertion
I have not heard about the USFM until now. Correct me if I am wrong, but it is used exclusively for Bible translations.
As you know, Atlantis does not have a dedicated feature to deal with the USFM. It would be probably inappropriate if Atlantis had such a feature since Atlantis is not a tool meant exclusively for Bible translations. However, adding such a feature to Atlantis would not be very hard from a purely technical point of view. If Atlantis offered a plugin interface, it would probably be the best way to add such functionality.
If you only needed “syntax highlighting” (as I understand, you mean permanent highlighting via font formatting – font color, highlight color, bold, etc) after-you-type, this can be easily done with the Find/Replace tool and its Batch Find & Replace. The wildcard search can match not only constant markers but also markers with variable parts. Please let me know if you need help with specific markers.
As things stand, Atlantis does not have a feature that would allow you to insert two-part clips before and after the selection.
As you know, Atlantis does not have a dedicated feature to deal with the USFM. It would be probably inappropriate if Atlantis had such a feature since Atlantis is not a tool meant exclusively for Bible translations. However, adding such a feature to Atlantis would not be very hard from a purely technical point of view. If Atlantis offered a plugin interface, it would probably be the best way to add such functionality.
If you only needed “syntax highlighting” (as I understand, you mean permanent highlighting via font formatting – font color, highlight color, bold, etc) after-you-type, this can be easily done with the Find/Replace tool and its Batch Find & Replace. The wildcard search can match not only constant markers but also markers with variable parts. Please let me know if you need help with specific markers.
As things stand, Atlantis does not have a feature that would allow you to insert two-part clips before and after the selection.
Re: Support for USFM syntax highlighting and automatic marker insertion
Thank you very much for your detailed reply - it clarifies the current situation perfectly.
You are right that USFM is mainly used for Bible translation work, so I fully understand why Atlantis does not include dedicated support for it. My request is not for a built in USFM module, but rather for two small, general purpose features that would benefit many workflows beyond USFM:
1. Regex based or rule based syntax highlighting
The Batch Find & Replace tool works well for static formatting, but it would be extremely helpful to have a way to apply formatting rules automatically as the user types, or at least to re apply them with a single command. Even a simple “re run all Batch rules” button would be very useful.
2. A way to insert paired text clips with the cursor placed between them
This is not specific to USFM. Many users working with markup like structures (HTML fragments, LaTeX commands, custom tags, etc.) would benefit from a feature that inserts an opening and closing marker and positions the cursor in the middle. Something like a “paired AutoCorrect entry” or a “two part clip” would be extremely helpful.
I believe both features would be broadly useful and not tied to any particular domain. If Atlantis ever introduces a plugin interface, I would be very interested in creating a USFM plugin myself.
Thank you again for your time and for considering these suggestions.
Regards,
Jerzy
You are right that USFM is mainly used for Bible translation work, so I fully understand why Atlantis does not include dedicated support for it. My request is not for a built in USFM module, but rather for two small, general purpose features that would benefit many workflows beyond USFM:
1. Regex based or rule based syntax highlighting
The Batch Find & Replace tool works well for static formatting, but it would be extremely helpful to have a way to apply formatting rules automatically as the user types, or at least to re apply them with a single command. Even a simple “re run all Batch rules” button would be very useful.
2. A way to insert paired text clips with the cursor placed between them
This is not specific to USFM. Many users working with markup like structures (HTML fragments, LaTeX commands, custom tags, etc.) would benefit from a feature that inserts an opening and closing marker and positions the cursor in the middle. Something like a “paired AutoCorrect entry” or a “two part clip” would be extremely helpful.
I believe both features would be broadly useful and not tied to any particular domain. If Atlantis ever introduces a plugin interface, I would be very interested in creating a USFM plugin myself.
Thank you again for your time and for considering these suggestions.
Regards,
Jerzy
Re: Support for USFM syntax highlighting and automatic marker insertion
1. The purpose of the Batch Find & Replace feature is to perform multiple search operations at once. There is no dedicated button, but there is a menu command within the “Find / Replace” panel of Atlantis.
2.
2.
I do not think this is a valid argument. Word processors are meant for editing formatted documents with the print layout in mind. For multiple reasons, a word processor is not the right tool to edit HTML code or a programming script. For these tasks, you have plain text editors, and more specifically code editors like Notapad++. By the way, there seems to be a USFM syntax highlighting plugin for Notepad++.Many users working with markup like structures (HTML fragments, LaTeX commands, custom tags, etc.) would benefit from a feature that inserts an opening and closing marker and positions the cursor in the middle.
Re: Support for USFM syntax highlighting and automatic marker insertion
Thank you for the explanation.
I understand the intention to keep Atlantis focused on its core strengths. Fortunately, the workflows of users working with structured text formats like USFM are already well‑supported by a variety of tools, so this request is not about expanding the scope of Atlantis. It is simply about refining a small interaction pattern that would make Atlantis more pleasant to use for those who choose it.
1. USFM, Markdown, and similar formats are intentionally lightweight.
They were designed so that users do not need specialized environments or heavy tooling.
A word processor with good ergonomics is often more than enough - and Atlantis already provides most of what such users rely on.
2. Word processors routinely handle structured elements.
Styles, fields, footnotes, comments - these are all structured constructs.
A shortcut that inserts an opening and closing marker with the cursor in between fits naturally into this existing ecosystem, without altering the philosophy of the application.
3. This is a micro‑interaction refinement with a high usability payoff.
Automatic pairing of elements is a standard pattern in modern text editing.
It reduces friction and helps avoid small, repetitive errors.
It’s the kind of detail that users immediately appreciate, even if they could technically manage without it.
4. Suggesting Notepad++ is understandable, though it addresses a different workflow.
Users working with long narrative texts often prefer a document‑oriented environment.
Those who work with USFM already have multiple tools available; the question is simply whether Atlantis wants to remain among the comfortable options for this type of work.
Regarding the suggested Notepad++ UDL: I appreciate the intention, although the referenced definition is over a decade old and does not reflect the current state of USFM or modern editing workflows. Users working with structured text already have access to many external tools - often more up‑to‑date than that.
5. The feature benefits more than just USFM users.
Anyone using custom tags, placeholders, annotations, or structured comments would gain from it.
This makes it a general UX improvement rather than support for a niche format.
In short, users will continue working with USFM regardless of which tools support them.
This small enhancement would simply make Atlantis a more attractive and efficient choice for those who prefer to stay within a word‑processing environment.
Regards,
Jerzy
I understand the intention to keep Atlantis focused on its core strengths. Fortunately, the workflows of users working with structured text formats like USFM are already well‑supported by a variety of tools, so this request is not about expanding the scope of Atlantis. It is simply about refining a small interaction pattern that would make Atlantis more pleasant to use for those who choose it.
1. USFM, Markdown, and similar formats are intentionally lightweight.
They were designed so that users do not need specialized environments or heavy tooling.
A word processor with good ergonomics is often more than enough - and Atlantis already provides most of what such users rely on.
2. Word processors routinely handle structured elements.
Styles, fields, footnotes, comments - these are all structured constructs.
A shortcut that inserts an opening and closing marker with the cursor in between fits naturally into this existing ecosystem, without altering the philosophy of the application.
3. This is a micro‑interaction refinement with a high usability payoff.
Automatic pairing of elements is a standard pattern in modern text editing.
It reduces friction and helps avoid small, repetitive errors.
It’s the kind of detail that users immediately appreciate, even if they could technically manage without it.
4. Suggesting Notepad++ is understandable, though it addresses a different workflow.
Users working with long narrative texts often prefer a document‑oriented environment.
Those who work with USFM already have multiple tools available; the question is simply whether Atlantis wants to remain among the comfortable options for this type of work.
Regarding the suggested Notepad++ UDL: I appreciate the intention, although the referenced definition is over a decade old and does not reflect the current state of USFM or modern editing workflows. Users working with structured text already have access to many external tools - often more up‑to‑date than that.
5. The feature benefits more than just USFM users.
Anyone using custom tags, placeholders, annotations, or structured comments would gain from it.
This makes it a general UX improvement rather than support for a niche format.
In short, users will continue working with USFM regardless of which tools support them.
This small enhancement would simply make Atlantis a more attractive and efficient choice for those who prefer to stay within a word‑processing environment.
Regards,
Jerzy
Re: Support for USFM syntax highlighting and automatic marker insertion
Thanks for sharing your thoughts.
As I said earlier, Atlantis cannot have USFM-related features for the reasons mentioned above. Same regarding other features that promote unorthodox use of the word processor. So there will be no command to insert “code snippets”.
But your feature request gave me an idea regarding another feature of Atlantis – the Clip Library. Items of the Clip Library (or just clips) can be inserted into the document as-you-type. After you have inserted a clip into the document, the blinking cursor gets placed after the inserted clip. This is fine in the absolute majority of cases. But for some clips, it might make sense to place the cursor at a certain location in the middle of the clip. For example, after you have inserted a clip containing a table, why not automatically place the cursor within the first blank cell? The required cursor location will probably be marked with a bookmark with a special reserved name, or with a reserved character (in case of plain text clips). So, conceivably you could compose your collection of USFM clips and insert them as-you-type.
As I said earlier, Atlantis cannot have USFM-related features for the reasons mentioned above. Same regarding other features that promote unorthodox use of the word processor. So there will be no command to insert “code snippets”.
But your feature request gave me an idea regarding another feature of Atlantis – the Clip Library. Items of the Clip Library (or just clips) can be inserted into the document as-you-type. After you have inserted a clip into the document, the blinking cursor gets placed after the inserted clip. This is fine in the absolute majority of cases. But for some clips, it might make sense to place the cursor at a certain location in the middle of the clip. For example, after you have inserted a clip containing a table, why not automatically place the cursor within the first blank cell? The required cursor location will probably be marked with a bookmark with a special reserved name, or with a reserved character (in case of plain text clips). So, conceivably you could compose your collection of USFM clips and insert them as-you-type.
Re: Support for USFM syntax highlighting and automatic marker insertion
This feature is available in the latest build of Atlantis.