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

[Jaak Ristioja]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

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

On 18.05.2014 21:54, Chris Burrell wrote:
> 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 
> <mailto:dmsmith at crosswire.org>> wrote:
> 
> 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
> <mailto:jaak at ristioja.ee>> wrote:
>> 
> 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).
>> 
>> _______________________________________________ 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
> 

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)

iQgcBAEBAgAGBQJTekc8AAoJELozJlbjIn79Z18//1WLWGSRknUsDpD7AtEI1Ckv
mokgznmri+zrJGHuATDt3OgMjY+thMMSy2BPtDk8CfeQ/9KhivxBArB7McC1hgWc
+w+12CN81u3hSTLabMjQst3RKwidCsYg/6uHZarnF9bOgpzjzGC9UNjMaiXS5t84
ekYL2pSTv5W3NuGJ0BEkobg0gRydtUHmKH2ZShA3q5WHHhLrGx6sSy3iY98HSXcO
465UeK3AfGwjj2SAAaQCRvjOXdX1ZVv1qq3A1BMmueT8moViC4C9QXmrygPPC1rP
s6XBbuFKP04HogApn4KGnSZnrIJyW0hiCRKwqsSh3TK5Vy9aRYfxPc+lU4ur9HaX
3TtmaC4jrQrHxpjMneZhXeS8KSsfsp+GeqVdTUOu4ShukcsrAQl/AT+olQ7aJf09
1WLvnU5f6HTXREwpoLKxy6tZSW56kqZTbh20fNE/Rc3TnPAXzSTEwwiWYn6+Sal+
hxXKxoaAXhnMaTo8M3GjqQFl2t74Aq9NVctR1nz2QpCkK3XPTGtVyKqGxgATmWT/
Gx9dYvRtOBHIvDxRsvU3egYPhqoIc4BRCFuYVJTeDnWvWbfq9jWXAfYycYJy+ikZ
QuP0Lv8TBgDccL4l8srHFYse1rWGgEXZjIU2AhK7H3KuOaP3VHnHFWwrGUiTRwCG
VY3weNtNTdr9MnPgeC0McJnl4LiIdyTiKt72dSDf3fYfWVbXz2QPWiCvzauu31cN
NiBD87r4vafIo7PcKvUQdXEbxdF5ygGUmWeVqbqinlXV0ggKF6v25T5JANEFv90g
TXbleCEZ6MY+YULeS4PnfmLvl7vtmgRRd680yAFW0yD0ukYRgTU/F2tEDlYQOxPt
rLdO3KM/JIxf298uRlbo0WvP4PmqgtAeeNa5rRNCfkY/VuCrK4lvKlNVS3evNN1n
iv7JMLOyBRDux+zVCKNRr8o4CVvLoap/YNO4x0tmIc7jlFwpK8HVCbXxBTV9khX5
lUXX+ycB3DohdvBf74d9AeouXbS9fN9vvJ0DRH9y6oj6gR9/CAYAVJ3dUjamswl5
dWbdy6CLodtyOiAoP3Uf/3pwOhdSJ5EZm0P69iQXuhVUukO+gCC2AmkRLPlwM4zJ
QX3fBjMJ3rNIuN6vPzLlX+h1QOKZq8zSt9E8FW5JfatreYXBaQE209VD4McFeEi7
4ifVOujV/x00/wPELgqJUIA7RSrHnoI9tQaPUKxb2Uv9iw4KbcgAu/eDlZsoXfeC
HHcDhhuPqRTXokEQMpFoVOSKM0qWjMJPksmUpiwkLNEhPJOoyzRNKFHXh+IunkGH
x+fmIu2vF3/pVf99ZHO6oNIigAVRnJbmDT5n37OUkHERIZxFKIMsntmcyDqahS2m
6vk2qrLsnXSTLZZ0mKcnRYAsGYkSt5Z67/KcbxI/d5WZspUpTebctyNWrcQDvwcp
85msWH33ycHourbnN04VD+8W0G9p7Ep9uNaXOD+a6097nAlhXI20rn3vX8j6QN2V
9mNGRjORLbKf0ch7sQwuiJSLyxFx2F8kSXyTZ0X0z2KbqOXCR7wJlpbIZHgUl3l6
4Qc7d0AhpRZIx6R5Os5htE+l44j75gPMn3EszV7MmQ0Wd74HsPgkx/Yre89tnJgA
98OC6pevSjovLKf5liRfn3AYSQz6yJDtccrrZkuYEIBKgBlvVyIauADiiV2h5iGC
ueHzK0OUcl6rBtWMULBEJjY2HkeiMuOhqXkqlDIftUF4hZGHLBpWASajzitRV+EJ
soNBZfzXHboKX0ZYdNlcVmNTqCiXMGTbBycvbWpGD/EvfOa0dQKF4t0M9PkMr/yK
9/FVdUPVsa5vSo90RENExDNlXlc6XBT23/k7B/p8RrtAZ40NeNIRfH57XxkCr126
1pnQERleBClfqA7HBtjg3xPWivSDvYLKSVOBPvX9AFb2KQ5IhjLBrMd86l4iDc0d
/WtSokUXkmuZ+y6q/fjzeYls9LSu6jNSaha+s6PFxSAc7FZ8nzwyCT+2bZKrDDjK
tNkLVcPNqwgS8IkS4PyveY8aq7EvhNaTwrmAqE+5VBmKMTQo0GXzYfREzCWzDiS+
byKLI2c561SjqXZLkhk9Ey0sJwU7WTimyp56UAWmaiBWF+2qbjqvPcT/paiIA1r0
po0gbJQJO3NPInN++hEUGLv2HGLDF1KNe3BuZe8Jq2SHGqO9MKXdZp/ES32UqTMn
7Brhj3bQOTHYnXbGumCUp/NcjdaBrk9BYwNNCqXfdW2bABeaNADGqP6v9XjVUcDd
nPKBveraOrTNhscBvCcQPFudEjy0L1GcVzLs6zF5ek4gz9Env8RK3I+6qnnuqpmT
DsXfYXvKICVAYAwvRIoSFjxBH0p2pmYbOW/ISSdTH3N38aSqBSzM5OSp6zsC6DeG
9LcHlYdAReMMqCy1U7OkNmXoxQ5RzBP1yHjX+Pody0aURUbTRjoeOk8I1isey3wS
0glWXBHIJ5i3nYgpAQ6IMlG5Takvo/QWcCbP6cZ7kBEUs/gxAjbulpHM9f63Y4aw
bU4Vt0LJUwJR2YVoXXlYoxTyKDqiLkpkeG5uu8yzSJ93iCnFrcC+1BWNw5LKCzCC
kLBoh8iQsWNe/BJ+JTvMtLNZ3N9yxouvifE6t86+0TjafWFZ5sFk//IVKLNqJ7uO
CKl45AAeWz3xI8zg3ctaZN3w+wLyVdPieYGxtO6he8UmAUv3CdIXwcffVugMgDHM
ttStnbQYFqZcpW1FB3us
=DYmk
-----END PGP SIGNATURE-----