feature: index entries #137

Activity

1. scanny

   changed the title [-]Creating index entries[/-] [+]feature: index entries[/+] on Feb 5, 2015
2. scanny

   added

   field

   on Feb 5, 2015
3. scanny commented on Feb 5, 2015

   

   scanny

   on Feb 5, 2015

   Contributor

   More actions

   Hi Walter, not presently unfortunately. This is part of the fields capability if I'm not mistaken and hasn't been implemented yet. I'll leave this issue open as a feature request for it.
4. wfb commented on Feb 7, 2015

   

   wfb

   on Feb 7, 2015

   Author

   More actions

   With Steve's excellent help, I got it all working. Here is the relevant piece of code for marking index entries:

   from docx.oxml import OxmlElement
   from docx.oxml.ns import qn
   
   def MarkIndexEntry(entry,paragraph):
       run = paragraph.add_run()
       r = run._r
       fldChar = OxmlElement('w:fldChar')
       fldChar.set(qn('w:fldCharType'), 'begin')
       r.append(fldChar)
   
       run = paragraph.add_run()
       r = run._r
       instrText = OxmlElement('w:instrText')
       instrText.set(qn('xml:space'), 'preserve')
       instrText.text = ' XE "%s" '%(entry)
       r.append(instrText)
   
       run = paragraph.add_run()
       r = run._r
       fldChar = OxmlElement('w:fldChar')
       fldChar.set(qn('w:fldCharType'), 'end')
       r.append(fldChar)

   Thank you so much, Steve!
   Walter

   👍React with 👍2Reacted by Jason Thorpe and TDfromSydney
5. wfb

   closed this as completedon Feb 7, 2015
6. wfb

   reopened this on Feb 7, 2015
7. scanny commented on Feb 9, 2015

   

   scanny

   on Feb 9, 2015

   Contributor

   More actions

   Glad to hear you got it working Walter :)
8. hannesharms commented on Feb 17, 2015

   

   hannesharms

   on Feb 17, 2015

   More actions

   Would be great if you could explain how to use the function for images or tables for a newbie.
   The followingg has no effect on my document:

   document.add_picture('test.png', width=Inches(5.25))
   paragraph = document.paragraphs[-1]
   MarkIndexEntry("Test Caption",paragraph)
9. scanny commented on Feb 17, 2015

   

   scanny

   on Feb 17, 2015

   Contributor

   More actions

   @hannesharms Please use the mailing list for support questions:
   https://groups.google.com/forum/#!forum/python-docx.
10. scanny

    closed this as completedon Feb 17, 2015
11. mlateb commented on Jun 3, 2018

    

    mlateb

    on Jun 3, 2018

    More actions

    Thank you so much for sharing the code @wfb
12. TerryDSydney commented on Oct 7, 2019

    

    TerryDSydney

    on Oct 7, 2019

    More actions

    I copied your code into my python program and it worked first time. Thanks very much, @wfb
13. 42scientific commented on Feb 20, 2024

    

    42scientific

    on Feb 20, 2024

    Last edited by 42scientific

    More actions

    This discussion is very valuable, thank you!
    i am wondering, how to refer in the document back to the figure that was referenced by the method described above. So, if you define

    Figure 1: [some figure caption],

    how can you refer back to this figure in the text, such as

    "Figure 1 states that..."?