[sword-devel] Internal link via OSIS ref in GenBooks - bug?

[DM Smith]

On Jan 11, 2014, at 11:56 AM, Chris Little <chrislit at crosswire.org> wrote:

> On 1/11/2014 1:40 AM, Peter von Kaehne wrote:
>> I have created a new GenBook module, the Dark Night of the Soul by John
>> of the Cross (It will be submitted in short order)
>> 
>> In the process I found that links do not work as advertised in the wiki
>> 
>> http://www.crosswire.org/wiki/OSIS_Genbooks#Internal_Links
>> 
>>  i.e. formed like a usual osisRef
>> 
>> ModuleName:ModuleRoot.Section.Subsection.Target
>> 
>> but instead worked only if formed like this with slashes:
>> 
>> ModuleName:ModuleRoot/Section/Subsection/Target
>> 
>> I have no particular problem with this - as long as one way works and as
>> long as we explain in the wiki the working way, but I think it might be
>> a bug nevertheless, no?
> 
> As DM says, the Wiki is right. There is no legal alternative in OSIS.
> 
> I'm not sure it's a bug, either, however. (Or, if we were to call it a bug, I don't know what the solution would necessarily be.)
> 
> The problem lies with this being somewhat front-end specific, so I'm curious about which specific front-end(s) you found to work with the second format. It's possible that most of them would treat the whole thing as a big SWKey and are completely ignorant of the internals or format.
> 
> I don't recall whether front-end authors decided on a common GenBook ref format for XHTML markup, but if we just convert dots to slashes and it works for a number of them, then a quick solution would be to add that conversion to the OSISXHTML filter.

I vaguely remember a discussion here a long time ago regarding mapping titles of sections (aka keys) to something acceptable as an osisRef. I seem to remember that _ was to be a replacement for space. There may have been others such as '.' (period).

IIRC, the problem is that key parts are show to users and what is shown to users is used as a part of a key.

Either way the problem is the same nature as encoding and decoding a URL.

I think that the engine should be updated to represent what is desired. But I am not volunteering;)

In Him,
	DM

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4145 bytes
Desc: not available
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20140111/5dbef911/attachment.p7s>