[sword-devel] RTF in About field of .conf files

Discussion:

Jaak Ristioja

2014-05-18 15:10:11 UTC

Hi!

http://www.crosswire.org/sword/develop/swordmodule/ states:

"About is a lengthier description and may include copyright, source,
etc. information. It may be formatted as RTF or as plain text."

I agree that something more than plain text is needed for anything
more than one non-formatted paragraph of non-formatted text. But as
everybody surely knows, all RTF starts with the string "{\rtf".
However looking at the .conf files in my ~/.sword/mods.d/, I conclude
that actually only a subset of RTF is allowed in the About field.

I have two questions:

1) What exactly are frontends required to support here? Groups?
Certain control words only?

2) How should a frontend distinguish between an RTF formatted About
field and a plain text About field? Search for RTF control words, fall
back to plain text if none found or if invalid RTF segment provided?

Thanks!

Blessings,
Jaak

PS: histmideast.conf contains a probably invalid \oar (did not find
this in the RTF specs).

Greg Hellings

2014-05-18 15:53:23 UTC

Permalink

I believe there is a standard class in the engine that does an RTF to HTML
conversion on arbitrary text. You should be able to pass these entries
through that converter to get out reasonable text.

--Greg

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hi!
"About is a lengthier description and may include copyright, source,
etc. information. It may be formatted as RTF or as plain text."
I agree that something more than plain text is needed for anything
more than one non-formatted paragraph of non-formatted text. But as
everybody surely knows, all RTF starts with the string "{\rtf".
However looking at the .conf files in my ~/.sword/mods.d/, I conclude
that actually only a subset of RTF is allowed in the About field.
1) What exactly are frontends required to support here? Groups?
Certain control words only?
2) How should a frontend distinguish between an RTF formatted About
field and a plain text About field? Search for RTF control words, fall
back to plain text if none found or if invalid RTF segment provided?
Thanks!
Blessings,
Jaak
PS: histmideast.conf contains a probably invalid \oar (did not find
this in the RTF specs).
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)
iQgcBAEBAgAGBQJTeM1QAAoJELozJlbjIn79Mg1AAM78348kfUfRm8FSyClswWey
/rld/AVKe7x/ug+7U1CTbPxdJdabCbPdxN3LmwkRLRDYQ7nk5pufzAyajMK0U/rW
m2eacM3FHR6R4qu0WZRSMIdCJtAUpgNUrwh6VwbS7T6UjPhPI3vKQWTHxnojWufR
J5RDXmE3TBSgyDDzhNa56cO64Isav1HCtcKAWwlLGxzc7PjpvID3N3Sitf1fm44o
ggCYpsIWO5Gq6jDyCuT08EmUdnM3d5VLoAHQpt5Slwf/Om8kOgF7h3iYTV+r2YWu
CYXEBApnJEuKT0iK2oE2XM+7heO1cC/ps4uhzSBE6F6ZJ5j6sfsQU5up8M7y9qQi
gO/lmewSavGPd/4H3kpdrmDLxRodtvsS+IN/w/yzeQjx+VSvJ6L8ZE1jRaUFHfwe
LpAWPBAVHnK5+dmIhcWFQnrLOdH6q8QMybejE7M9RRuy/hx62O3mCXfi4lDDmpGQ
y4gPGmDKUpv+UGl+tQjBqP69nF4aeC6OShr6LMyOWfr/XhxCyglnwJfEHDZj0D/j
wz7FW+NaZzc48ci0u8wNjcZqsbQBkmB10mX/KzfyL6i0PzljJ4akuYT+od52YlIS
inPOfZz6CEZmjq6ETNTUoK0JzpECtQwttTR5hEE3v7N+4BTMKKxfT196QG6RSNt7
wIGLchYhDcYN0K6YYi8TUpULKsLWDH1N0h6/CtBfaWEaIIoBuuIZLTkEAa1aiS3S
z2tqGcqB2dO3fNHKE7GRj67EJoO7ocVorp++0E8peClrAB68V6rVuEcSpOtefA8b
IPEVnT98zD+gAoUMX1sCbaQ5C6wIsuhGmfK1wd4hb+QCmuOwstVcRvPN19otPXtL
G1AbE4KKvWlytAmg2cUHw1LeNKr5h2cZSmPYB4xkr6FG9Cxj4l6ZRGv6Z3pQSOcS
LVG+vjY89SF0X81LiJR77D1xkK5a4h/QCo0a5FWEvbnfi6uhTkyZpN3+qmkdly9V
i1Uj+g09FKPFC4X7BoC7wCsV0I92VELi2cTsLfK2bUNjyDuWxJfhxiQ8NSgPSq1x
1OkWSv56iwwqP3LJMno5jfPAp6KGUJeaGzc9I02bNP3+XGYyNCuFtg/Ekp6ttmkX
xlMjQGtpHdjT7qp+vJiLylCRIMolzbWxZPMeaFWmHRjDJ9NNA2+3L3iJi6Z1nmsu
VyOwVmh2TJRwEDGyQPPY6ioabX3pyo3RSIuklo7D2duhOLVOeTIMn3aiOf9G6f4A
7+07P6kVz7mG22z4004uwgosrbjMsQWBAMhSfcqVKEbJo8q4gg5v2q40dEhCFtCI
fuM7tdD/gZAGwomdPJdR3A6Wh3Acf/bTIjdKgx/ce0LQTuLiMFaVDpJ6TWrYC3Vc
QRRuWw9iefKdsJvRau/yiqjm2C1kmOPuZy1WaWq1hYNAjMwQKTpRepdcxtxAQ+4S
YhJEb9yBZezgsFWe9WfSU48ttoOEVPriOdX5e6Y3tL7BxveIzslyix93uXiLcCXi
sT7PwS8egZNd2BBZhDnPA49JAlhj6O3ZiRFfPfbeG3Jtk3WnmQL1nPnBfggEySBf
G82DhrKxmH5fEhCdmxBax5MdhXdwHJHj3/noI+arMFM+5PfUgvU4FdH6fEY1ZJW2
w/AWt/c3C460J+l1PO3G3P2Eo8LJXI3vLIBIC6cNZAEb0ysywgk2kD05PNKt6rxC
gfqLSKMPcFk/hJWmTruzJXcB0tuNsM/wGNbRuAvrMQQEmxULV1jEp1IvXgl/gNpR
slESiqVbi3BnUgtslwVW7MhjDbTYAiJAma1fFJz4n59bVVH1rtY9MktWqiVyrfjg
WsLQKaV5PwydaCuW+XymfpUKtzXfk4qGhOfA7K6YW8OZr/MsLwlrbZC0N6qFw5PJ
Gf4gTr0XcK2062OAUvhLSnQScUZBro9cTWspvfqAdtjP6GP+2esMXEAeR0WfRN04
IeBqsPpjOXxKYqZ8z4aOEPwlYPZ7AvZy0BekYSAPrlexqwoTu7dBWBzVOVfbMBv/
WEAly0nLQtpY0/uCKOjJyYm6Q0ILcMtKvmgi9ciCfwKcIsP/n41JYhHBJ2KFAK+P
jqFfXY4gt7tQCN+neV//vBMpC2OnmKogsKMwnC2aaqDbRYY+viCONmQs7Xpep7ZN
/LfsQSCGf4p8JaYeVZmsWFEWuEIJWNC4X3Ntj3ABY/ADnfgHi2BPaF8r/llESgjB
bX+aLeS5VYmlpgq1wBLdm2nLGEWrLqO2+dNZMPKOb/B1m74dqSf7v+0CulSEijix
aAOLEbd4Aq4u1Q/UmB57+yMIjXMz+wk3j00xrZ7MqgDuy18wO4pzZoPF5GrOnB9k
R7YqppZk9LD27EMyyOySxVlpjQy78PdCVkN+xb//Kf9QEXVlXefz0RaGmPvdU/jO
LVd10TyHNDKGqgVtquicyY1n71YZfNCpAbCDFLQOsi7h2Nn5Puewok5mJwpsTc9m
wXoQpOFItDJZD5XiOpSnXvVMKR/aj3Z7sVzLXx8ogeg7Y9XxUejRCtXXxOB0XoC2
56uKpwmjVrUii4KnNu3mQN+vaeIIv7PySAoed0fGQGwUHZqxiX1wC1dK5IM9BNAk
+boQS0dkeZSUxnnf+/3UVkXCI8d04UAix8VykQd3B1mGNSX2IwLzBdKC7Mv+1py3
megzDHZ153i+z+/0DPdQiGWICscjVNhJmoWfZSsxxc+gI1QHsW5/VCDIqqQsWlfb
S9icGJc263KWbhTsoKj4
=Vm2Q
-----END PGP SIGNATURE-----
_______________________________________________
sword-devel mailing list: sword-devel at crosswire.org
http://www.crosswire.org/mailman/listinfo/sword-devel
Instructions to unsubscribe/change your settings at above page

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20140518/1b7d3216/attachment.html>

DM Smith

2014-05-18 17:01:04 UTC

Permalink

Only a subset is allowed in the conf. The following page gives details. SwordWeb and JSword assume that the field is RTF even if plain text. \oar looks like a typo for \par.

http://www.crosswire.org/wiki/DevTools:conf_Files

Chris Burrell

2014-05-18 18:54:11 UTC

Permalink

Worth noting in passing that jsword currently let's the frontend handle
these including the unicode characters marked using rtf notation.

Chris

Post by DM Smith
Only a subset is allowed in the conf. The following page gives details.
SwordWeb and JSword assume that the field is RTF even if plain text. \oar
looks like a typo for \par.
http://www.crosswire.org/wiki/DevTools:conf_Files

_______________________________________________
sword-devel mailing list: sword-devel at crosswire.org
http://www.crosswire.org/mailman/listinfo/sword-devel
Instructions to unsubscribe/change your settings at above page

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20140518/8fc0e220/attachment.html>

Jaak Ristioja

2014-05-19 18:02:39 UTC

Permalink

So to sum this up:
* RTF lexing rules (especially regarding control word delimiters etc)
should be used for the rest of the .conf file line after About=.
* RTF groups are not allowed.
* RTF control symbols are not allowed.
* Of RTF control words, only \qc, \par, \pard and \u{num} are allowed,
where {num} is a decimal string representation of an int16_t.
* When frontends fail to treat the input as such, they should consider
the value a plain text value.

Is this correct?

J

Post by Chris Burrell
Worth noting in passing that jsword currently let's the frontend
handle these including the unicode characters marked using rtf
notation.
Chris
On 18 May 2014 18:03, "DM Smith" <dmsmith at crosswire.org
Only a subset is allowed in the conf. The following page gives
details. SwordWeb and JSword assume that the field is RTF even if
plain text. \oar looks like a typo for \par.
http://www.crosswire.org/wiki/DevTools:conf_Files

On May 18, 2014, at 11:10 AM, Jaak Ristioja <jaak at ristioja.ee

Hi!
"About is a lengthier description and may include copyright,
source, etc. information. It may be formatted as RTF or as plain
text."
I agree that something more than plain text is needed for anything
more than one non-formatted paragraph of non-formatted text. But
as everybody surely knows, all RTF starts with the string "{\rtf".
However looking at the .conf files in my ~/.sword/mods.d/, I
conclude that actually only a subset of RTF is allowed in the About
field.
1) What exactly are frontends required to support here? Groups?
Certain control words only?
2) How should a frontend distinguish between an RTF formatted
About field and a plain text About field? Search for RTF control
words, fall back to plain text if none found or if invalid RTF
segment provided?
Thanks!
Blessings, Jaak
PS: histmideast.conf contains a probably invalid \oar (did not
find this in the RTF specs).

_______________________________________________ sword-devel
mailing list: sword-devel at crosswire.org

<mailto:sword-devel at crosswire.org>

http://www.crosswire.org/mailman/listinfo/sword-devel
Instructions to unsubscribe/change your settings at above page

_______________________________________________ sword-devel mailing
list: sword-devel at crosswire.org <mailto:sword-devel at crosswire.org>
http://www.crosswire.org/mailman/listinfo/sword-devel Instructions
to unsubscribe/change your settings at above page
_______________________________________________ sword-devel mailing
list: sword-devel at crosswire.org
http://www.crosswire.org/mailman/listinfo/sword-devel Instructions
to unsubscribe/change your settings at above page