Changeset 13291

Timestamp:

2006-11-17T10:46:29+13:00 (17 years ago)

Author:

lh92

Message:

add in the formatting_word_pdf exercise of how to pass the search terms to Acrobat

File:

• trunk/gsdl-documentation/tutorials/xml-source/tutorial_en.xml (modified) (1 diff)

trunk/gsdl-documentation/tutorials/xml-source/tutorial_en.xml

@@ -1053 +1053 @@
 </Format>
 </NumberedItem>
+<Heading>
+<Text id="fw-24">Opening PDF files with query terms highlighted</Text>
+</Heading>
+<NumberedItem>
+<Text id="fw-24a">Next we'll customize the <AutoText text="SearchVList"/> format statement to highlight the query terms in a PDF file when it is opened from the search result list. This requires Acrobat Reader 7.0 version or higher, and only works on a windows platform.</Text>
+</NumberedItem>
+<NumberedItem>
+<Text id="fw-24c">The search terms are kept in the macro variable <AutoText text="_cgiargq_"/>, and we can append <AutoText text="#search=&quot;_cgiargq_&quot;"/> to the end of a PDF file link to pass the query terms to the PDF file.</Text>
+<Text id="fw-24d">By default, each PDF file is renamed as <AutoText text="doc.pdf"/> and saved in a unique hash directory when processed by <AutoText text="PDFPlug"/>, so we use</Text>
+<Format>_httpcollection_/index/assoc/[archivedir]/doc.pdf</Format>
+<Text id="fw-24e">to locate the PDF source file in a search result list.<br/>If you used the <AutoText text="-keep_original_filename"/> option of the <AutoText text="PDFPlug"/> to build the collection, then the original name of the PDF file is kept, and we use</Text>
+<Format>_httpcollection_/index/assoc/[archivedir]/[Source]</Format>
+<Text id="fw-24f">instead to locate a PDF source file.</Text>
+</NumberedItem>
+<NumberedItem>
+<Text id="fw-24g">Select <AutoText text="SearchVList"/> from the list of assigned formats. We first judge whether a file in the search result list is a PDF file, we can use</Text>
+<Format>[ex.FileFormat] eq 'PDF'</Format>
+<Text id="fw-24h">in an <Format>{If}</Format> statement to do this. Then we use the above format instead of the <AutoText text="[ex.srclink]"/> and <AutoText text="[ex./srclink]"/> variables just for the PDF files.</Text>
+<Text id="fw-24b">The resulting format statement looks like:</Text>
+<Format>
+&lt;td valign="top"&gt;[link][icon][/link]&lt;/td&gt;<br/>
+&lt;td valign="top"&gt;<highlight>{If}{[ex.FileFormat] eq 'PDF', &lt;a
+href=\\"_httpcollection_/index/assoc/[archivedir]/doc.pdf#search=&amp;quot;_cgiargq_&amp;quot;\"&gt;[ex.srcicon]&lt;/a&gt;,<br/>[ex.srclink][ex.srcicon][ex./srclink]}</highlight>&lt;/td&gt;<br/>
+&lt;td valign="top"&gt;[highlight]<br/>
+{Or}{[dc.Title],[ex.Title],Untitled}<br/>
+[/highlight]{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}&lt;/td&gt;<br/>
+</Format>
+<Text id="fw-24i">When the PDF icons are clicked in the search results, Acrobat will open the file with the search window opened, and the query terms highlighted.</Text>
+</NumberedItem>
 </Content>
 </Tutorial>