[sword-devel] UnlockInfo .conf entry

[Troy A. Griffitts]

Hi Jaak, thanks for the feedback...

On 12/29/18 5:39 PM, Jaak Ristioja wrote:
> Why can't the About= entry contain this information?

The About= entry does contain this information right now, but it usually
contains too much information for a nice, short, description for a UI to
display instruction how to obtain an unlock code.  The About= usually
has a ton of copyright and usage info, especially for a locked module.


> I'm unsure whether "UnlockInfo" is the best name.

Do you have a better suggestion?


> Is it safe to assume that this entry will only be relevant for modules
> with a CipherKey= entry?

Yes


> Using HTML might be a can of worms:
This is defined in our wiki:

"Some allow HTML <a href="xxx">label</a>hypertext links. HTML is not
allowed otherwise."

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

Lookup up this in our wiki, I found an entry which I am not sure where
it came from.  I have checked out repo and don't see any instances.  It
looks like it was added to the wiki by Osk and could have been from a
conversation I had with him years ago, but I don't remember:

UnlockURL=

Regardless, I would still like to move forward with the here proposed
UnlockInfo, as it gives the publishers an opportunity include verbiage
in addition to a link.

Troy


> On 30.12.18 00:02, Troy A. Griffitts wrote:
>> Dear Frontend Developers,
>>
>> In an effort to gain more publishers-- even those who desire to lock and
>> sell some of their modules, I would like to add a new .conf entry:
>>
>> UnlockInfo
>>
>> Up until now, we've relied on the About entry containing something that
>> lets the user know how to obtain unlock codes from publishers selling
>> codes to unlock their modules.  This entry would isolate just those
>> instructions to a specific entry and would allow a frontend to do
>> something like:
>>
>> If (moduleToInstall.getConfEntry("UnlockInfo")) {
>>
>>   showDialog("<p>The publisher of this modules requires for you to
>> obtain an unlock code.  This code can be entered below, instructions
>> from the publisher are as follows:</p>" +
>> moduleToInstall.getConfEntry("UnlockInfo"));
>>
>> }
>>
>> Like many of our entries, this new UnlockInfo entry will allow HTML
>> links and will likely contain a direct link from the publisher to their
>> store entry to purchase an unlock code.
>>
>> An example would be something like:
>>
>> UnlockInfo=An unlock code for the Larry Fitzgerald NFL HOF Edition of
>> the New Testament, with memorable career moments encouraging the
>> believer to press on when those around fall short, may be obtained
>> directly from the NFL store here: <a target="_blank"
>> href="https://nfl.com/shop/lf-nfl-hof-nt-sword-module">Larry Fitzgerald
>> NFL HOF Edition of the New Testament - SWORD Module</a>
>>
>> Let me know if you have any comments or ideas,
>>
>> Troy
>>
>>
>>
>> _______________________________________________
>> 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
>>
>
> _______________________________________________
> 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/20181229/e445702b/attachment-0001.html>