Is `ide` valid in USX? about biblemulticonverter HOT 6 CLOSED

In my opinion the \ide tag is only valid in USFM, and not in USX or USFX.

The system should also behave as such:

• When converting from USFM, text is read accordingly
• When converting to USFM, \ide UTF-8 is written and the file is written as UTF-8
• Neither USFX nor USX formats have any special logic concerning the \ide tag.

The only path where I am unsure is when you use ParatextConverter to convert USFM to one of the other Paratext formats. In that case, ide tag gets stored in the book attributes and may (did not verify this though) be written out to other Paratext formats. Pinging @Rolf-Smit as he overhauled the USFX/USX support in commit 891a996, which probably introduced this change.

from biblemulticonverter.

Thank you for confirming my suspicion.

@Rolf-Smit, do you remember why you added the '\ide` tag to the book attributes?

If not, I'll remove it (and the check to avoid writing it out for USFM export in

from biblemulticonverter.

Yes that was my thinking, but when converting from USFM to USX using ParatextConverter the ide is getting written out as a para element:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<usx version="3.0"><book code="1CH" style="id">World English Bible (WEB)</book>
  <para style="ide">UTF-8</para>
  <para style="h">1 Chronicles</para>
  <para style="toc1">The First Book of Chronicles</para>

I'm simply ignoring it now when converting to HTML but it might be good to get rid of in case future projects get stuck trying to parse it.

from biblemulticonverter.

@schierlm I don't remember why it was added. Maybe it was to preserve the original encoding? But that doesn't make sense anyways, since USFM is always written out as UTF-8 and other formats like USX must be written in UTF-8.

I would say, remove it.

from biblemulticonverter.

Thanks!

from biblemulticonverter.

It turns out apparently it is valid. I discovered that not all elements are documented but can still be found in the schema: https://github.com/ubsicap/usx/blob/master/schema/usx.rng

ide is there, but as we discussed it doesn't really have any value as encoding is handled at the XML level, and if you want to convert back to USFM you could potentially choose whatever encoding you liked.

(no action needed, just thought I'd document this for future readers)

from biblemulticonverter.