[sword-devel] What markup format is SWORD's internal markup, and/or where is it documented?

Greg Hellings greg.hellings at gmail.com
Fri Dec 15 22:12:08 EST 2023


The actual files are a custom binary format which is not documented and is
not intended to be any sort of standard accessed by anything other than the
library itself.

Most newer works are imported from an OSIS file. Some older ones were
imported from GBF (I think?) or ThML (which is basically some basic HTML
display components mixed with a few tags for identifying things like words
of Christ or divine names). However, once they are imported as modules some
of that structure is lost to the proprietary binary format of the SWORD
module files.

If you want the text in Markdown the best way is to create a filter like
the existing filters in the engine which can be used to generate HTML,
LaTeX, etc and write some which produce Markdown output.

Although, since Markdown is basically simplified HTML that is specifically
intended to make HTML easier to write, why wouldn't you just render out
HTML from the existing filters and drop that into your Markdown editor?
Every md editor and renderer I've used will pass HTML through unchanged,
allowing the author to use its full syntax when they wanted to.

On Fri, Dec 15, 2023, 21:04 Aaron Rainbolt <arraybolt3 at gmail.com> wrote:

> I had an idea of making a primarily Markdown-centric SWORD frontend
> that would help with writing Bible studies and whatnot for
> Markdown-based platforms like Reddit or Obsidian notes. For this
> purpose, I want to parse the internal markup used by SWORD in its
> modules, and then use my own custom code to generate Markdown from
> that.
>
> Obviously I can learn a lot about this markup by simply looking at
> modules that use it, but I do wonder, is this markup at all
> standardized? Is it documented anywhere? Does it have a name of some
> sort that I can use to find handlers and tools for it in the SWORD API
> docs?
>
> Thanks,
> Aaron
> _______________________________________________
> sword-devel mailing list: sword-devel at crosswire.org
> http://crosswire.org/mailman/listinfo/sword-devel
> Instructions to unsubscribe/change your settings at above page
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://crosswire.org/pipermail/sword-devel/attachments/20231215/faf13739/attachment.htm>


More information about the sword-devel mailing list