Re: Index items

Re: Index items

[Robert Blackstone]

On 16 Apr 2015, at 15:38 , Hans Hagen <pragma@wxs.nl> wrote
> To: mailing list for ConTeXt users <ntg-context@ntg.nl>
> Subject: Re: [NTG-context] Index items
> Message-ID: <552FBB35.9050707@wxs.nl>
> Content-Type: text/plain; charset=utf-8; format=flowed
> 
> On 4/15/2015 11:41 PM, Robert Blackstone wrote:
>> 
>> On 15 Apr 2015, at 19:51 ,  Alan BRASLAU <alan.braslau@cea.fr> wrote
>>> Hans Hagen <pragma@wxs.nl> wrote:
>>> 
>>>> On 4/14/2015 1:48 PM, Robert Blackstone wrote:
>>>>> Dear all,
>>>>> 
>>>>> The book I am typesetting contains a very extensive and detailed
>>>>> index. The number of index items is probably around 1200, 16 pages.
>>>>> A fair number of them occur in more than one chapter.
>>>>> Like bibliography items, and for the sake of consistency, I have
>>>>> stored them in some auxiliary files and it is a matter of copy and
>>>>> paste to get them into the text in the proper place and way. (With
>>>>> always a risk of accidentally deleting or adding a spurious brace
>>>>> or bracket, with nasty results.)
>>>>> 
>>>>> I wonder therefore whether it would be possible to handle them like
>>>>> bibliography items, by means of a key, and leave their expansion to
>>>>> ConTeXt.
>>>>> 
>>>>> Would it be possible?
>>>>> And if it is not (yet) possible, how could I perhaps tackle it?
>>>> 
>>>> so you want to remap given index entries to new ones? at what moment?
>>> 
>>> We index pretty heavily now in the new bibliography dataset subsystem,
>>> that is one can create an index of authors, an index of keywords, an
>>> index of titles, etc. as well as index the pages on which a reference
>>> is cited. All of the information is there.
>>> 
>>> So say that you want to create a database of anything: words, images,
>>> phrases. You can put these into the database structure and then insert
>>> them or any associated information wherever you want in your text,
>>> later producing lists and indexes.
>>> 
>>> Can you give an example of what type of information you extensively
>>> index with detail?
>>> 
>>> Alan
>> Hi Alan,
>>  I realize that I have not yet reacted to Hans’ reply. So let me do that first (it was written but not yet sent).
>> 
>>  Hi Hans,
>> Do I want to remap given index entries? Assuming I understand your reply correctly the answer is: Yes, in principle. I would want to be able to change them if there are errors, or if some publisher has different views about the presentation of titles of items that are in the index (titles of songs, for instance). And also when (parts of) the text has (have) to be reused for other purposes. Change them in one operation, that is, not by digging up all occurrences in the book of the item that has to be changed.
>> 
>> In answer to Alan’s question: names, theoretical treatises and manuscripts, musical works, musical terms. Nearly all examples in the book have several features that have to be indexed: composer’s name, title of the published work (an opera for instance), title of the particular aria of which the example shows a fragment, and the special features that are shown in the example, parallel 7ths, for example.
>> The not-so-minimal example below (best processed iwth mkiv) gives an impression, also of the optical clumsiness that makes the unprocessed text practically unreadable. That is another reason why I would like to be able to call an index entry by means of some sort of key, like in bibliographic items for footnotes.
> 
> \startluacode
> 
>     document.indexentries = {
>         ["rule"]          = [[Rule(s)]],
>         ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
>         ["galilei"]       = [[Galilei, Vincenzo]],
>     }
> 
>     function document.getindexentry(n)
>         context("\\index[%s]{%s}",n,document.indexentries[n] or ("<" .. 
> n .. ">"))
>     end
> 
> \stopluacode
> 
> \unexpanded\def\InEn[#1]%
>   {\ctxlua{document.getindexentry("#1")}}
> 
> \starttext
> That this rule
> \InEn[rule]
> \InEn[ruleimperfect] was not applied by everybody is for example shown 
> in {\em Fronimo}%
> \InEn[galilei]
> 
> etc etc

Wow, this is super! Great improvement, also for the readability of the text.
Thank you very much, Hans.

Kind regards,
Robert

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________

Re: Index items (additional question)

[Robert Blackstone]

On 16 Apr 2015, at 15:38 , Hans Hagen <pragma@wxs.nl> gave me the following:

> \startluacode
> 
>     document.indexentries = {
>         ["rule"]          = [[Rule(s)]],
>         ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
>         ["galilei"]       = [[Galilei, Vincenzo]],
>     }
> 
>     function document.getindexentry(n)
>         context("\\index[%s]{%s}",n,document.indexentries[n] or ("<" .. 
> n .. ">"))
>     end
> 
> \stopluacode
> 
> \unexpanded\def\InEn[#1]%
>   {\ctxlua{document.getindexentry("#1")}}
> 
> \starttext
> That this rule
> \InEn[rule]
> \InEn[ruleimperfect] was not applied by everybody is for example shown 
> in {\em Fronimo}%
> \InEn[galilei]
> 
> etc etc

Hi Hans,
sorry to bother you again on this topic.

This code works beautifully in this way, with only a few index entries  at the top of the file, before \starttext. 
But how can I deal with the thousand or more index items in my project, which I have collected in four separate dedicated files with indexentries, like the three shown in the example-code.

I have really no idea  what else should be in these files,  what sort of name they should have, in particular extension,  and how and where I can input them.
I use TeXShop as my texteditor but that is probably not relevant here.

Can you give me some guidance, please?

Thanks in advance.

Best regards,
Robert Blackstone


___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________

Re: Index items (additional question)

[Hans Hagen]

On 4/19/2015 9:47 AM, Robert Blackstone wrote:
>
> On 16 Apr 2015, at 15:38 , Hans Hagen <pragma@wxs.nl> gave me the following:
>
>> \startluacode
>>
>>      document.indexentries = {
>>          ["rule"]          = [[Rule(s)]],
>>          ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
>>          ["galilei"]       = [[Galilei, Vincenzo]],
>>      }
>>
>>      function document.getindexentry(n)
>>          context("\\index[%s]{%s}",n,document.indexentries[n] or ("<" ..
>> n .. ">"))
>>      end
>>
>> \stopluacode
>>
>> \unexpanded\def\InEn[#1]%
>>    {\ctxlua{document.getindexentry("#1")}}
>>
>> \starttext
>> That this rule
>> \InEn[rule]
>> \InEn[ruleimperfect] was not applied by everybody is for example shown
>> in {\em Fronimo}%
>> \InEn[galilei]
>>
>> etc etc
>
> Hi Hans,
> sorry to bother you again on this topic.
>
> This code works beautifully in this way, with only a few index entries  at the top of the file, before \starttext.
> But how can I deal with the thousand or more index items in my project, which I have collected in four separate dedicated files with indexentries, like the three shown in the example-code.
>
> I have really no idea  what else should be in these files,  what sort of name they should have, in particular extension,  and how and where I can input them.
> I use TeXShop as my texteditor but that is probably not relevant here.
>
> Can you give me some guidance, please?

\startluacode

     document.indexentries = {
         ["rule"]          = [[Rule(s)]],
         ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
         ["galilei"]       = [[Galilei, Vincenzo]],
     }

     function document.loadindexentries(filename)
         local fullname = resolvers.findfile(filename)
         if fullname ~= "" then
             local data = io.loaddata(fullname)
             for a, b  in string.gmatch(data,"%s*(%S+)%s+([^\n\r]+)") do
                 document.indexentries[a] = b
             end
         end
     end

     function document.getindexentry(n)
         local ie = document.indexentries[n]
         if not ie then
             logs.report("index","missing entry %a",n)
         end
         context("\\index[%s]{%s}",n,ie or ("<" .. n .. ">"))
     end

\stopluacode

\unexpanded\def\LoadInEn[#1]{\ctxlua{document.loadindexentries("#1")}}
\unexpanded\def\InEn    [#1]{\ctxlua{document.getindexentry("#1")}}

\LoadInEn[whatever.txt]

\starttext
That this rule
\InEn[rule]
\InEn[ruleimperfect] was not applied by everybody is for example shown 
in {\em Fronimo}%
\InEn[galilei]

\InEn[unknown]

etc etc

\InEn[GalileiFronimo]
\InEn[Cadence]
\InEn[CadenceP]
\InEn[PlagalCad]
\index[Fronimo]{{\em Fronimo} (Galilei)} (1584), Vincenzo Galileo's 
treatise on lute playing and the intabulation%
\index[Intabulation]{intabulation}  of vocal music.
\page

whatever.txt:

GalileiFronimo +{\em Fronimo}
Cadence        cadence(s)
CadenceP       + plagal
PlagalCad      plagal cadence


-----------------------------------------------------------------
                                           Hans Hagen | PRAGMA ADE
               Ridderstraat 27 | 8061 GH Hasselt | The Netherlands
     tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com
                                              | www.pragma-pod.nl
-----------------------------------------------------------------
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________

Re: Index items (additional question)

[Robert Blackstone]

On 19 Apr 2015, at 11:55 , Hans Hagen <pragma@wxs.nl> wrote
> 
> On 4/19/2015 9:47 AM, Robert Blackstone wrote:
>> 
>> On 16 Apr 2015, at 15:38 , Hans Hagen <pragma@wxs.nl> gave me the following:
>> 
>>> \startluacode
>>> 
>>>     document.indexentries = {
>>>         ["rule"]          = [[Rule(s)]],
>>>         ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
>>>         ["galilei"]       = [[Galilei, Vincenzo]],
>>>     }
>>> 
>>>     function document.getindexentry(n)
>>>         context("\\index[%s]{%s}",n,document.indexentries[n] or ("<" ..
>>> n .. ">"))
>>>     end
>>> 
>>> \stopluacode
>>> 
>>> \unexpanded\def\InEn[#1]%
>>>   {\ctxlua{document.getindexentry("#1")}}
>>> 
>>> \starttext
>>> That this rule
>>> \InEn[rule]
>>> \InEn[ruleimperfect] was not applied by everybody is for example shown
>>> in {\em Fronimo}%
>>> \InEn[galilei]
>>> 
>>> etc etc
>> 
>> 
>> This code works beautifully in this way, with only a few index entries  at the top of the file, before \starttext.
>> But how can I deal with the thousand or more index items in my project, which I have collected in four separate dedicated files with indexentries, like the three shown in the example-code.
>> 
>> I have really no idea  what else should be in these files,  what sort of name they should have, in particular extension,  and how and where I can input them.
>> I use TeXShop as my texteditor but that is probably not relevant here.
>> 
>> Can you give me some guidance, please?
> 
> \startluacode
> 
>     document.indexentries = {
>         ["rule"]          = [[Rule(s)]],
>         ["ruleimperfect"] = [[+ \quote{imperfect to perfect, from}]],
>         ["galilei"]       = [[Galilei, Vincenzo]],
>     }
> 
>     function document.loadindexentries(filename)
>         local fullname = resolvers.findfile(filename)
>         if fullname ~= "" then
>             local data = io.loaddata(fullname)
>             for a, b  in string.gmatch(data,"%s*(%S+)%s+([^\n\r]+)") do
>                 document.indexentries[a] = b
>             end
>         end
>     end
> 
>     function document.getindexentry(n)
>         local ie = document.indexentries[n]
>         if not ie then
>             logs.report("index","missing entry %a",n)
>         end
>         context("\\index[%s]{%s}",n,ie or ("<" .. n .. ">"))
>     end
> 
> \stopluacode
> 
> \unexpanded\def\LoadInEn[#1]{\ctxlua{document.loadindexentries("#1")}}
> \unexpanded\def\InEn    [#1]{\ctxlua{document.getindexentry("#1")}}
> 
> \LoadInEn[whatever.txt]
> 
> \starttext
> That this rule
> \InEn[rule]
> \InEn[ruleimperfect] was not applied by everybody is for example shown 
> in {\em Fronimo}%
> \InEn[galilei]
> 
> \InEn[unknown]
> 
> etc etc
> 
> \InEn[GalileiFronimo]
> \InEn[Cadence]
> \InEn[CadenceP]
> \InEn[PlagalCad]
> \index[Fronimo]{{\em Fronimo} (Galilei)} (1584), Vincenzo Galileo's 
> treatise on lute playing and the intabulation%
> \index[Intabulation]{intabulation}  of vocal music.
> \page
> 
> whatever.txt:
> 
> GalileiFronimo +{\em Fronimo}
> Cadence        cadence(s)
> CadenceP       + plagal
> PlagalCad      plagal cadence
> 
Hi Hans,

Thank you for your reply.
It took me a while to make your code operational in the way I need it.
For the new example you gave is still an "integral file". My project, like most book-projects, I guess, is modular with a master file Project.tex, into which everything else, setups, .bbl's, front- and backmatter, the various chapters are input. Though strictly speaking it would not be impossible to add some 1000 lines of index entries before \startproject, it would not be especially handy, and I cannot believe that it would be the proper ConTeXt-way to do it.

I found that when I split your code, transferred the top part to a new file, which I named "IndexItems", and input that into the other half, the text proper, it works. But when I add another file with indexentries, for instance "indexitemsnames", then only one of them, the one at the top is used. 
So it seems that the whole collection of index items must be in one file.
Is that the only possibility or are there ways to enable the use of several collections of index items?

Best regards, 
Robert
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________