Changeset 36969 for documentation
- Timestamp:
- 2022-12-05T16:24:13+13:00 (17 months ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
documentation/trunk/tutorials/xml-source/tutorial_en.xml
r36364 r36969 1418 1418 </Heading> 1419 1419 <NumberedItem> 1420 <Text id="ep-sd-2">In the table of contents (on the right) by default a section number and section title are displayed. For documents like these where the section titles are the same as the section numbers, this doesn't make much sense, as you end up with headings like "1 1". We can hide the section number from the display by adding some CSS style information.</Text>1420 <Text id="ep-sd-2">In the table of contents (on the right) by default a section number and section title are displayed. For documents like these where the section titles are the same as the section numbers, this doesn't make much sense, as you end up with headings like "1 Page 1". We can hide the section number from the display by adding some CSS style information.</Text> 1421 1421 </NumberedItem> 1422 1422 <NumberedItem> … … 1463 1463 </NumberedItem> 1464 1464 <NumberedItem> 1465 <Text id="fw-24c-3">To highlight the query terms in a PDF document, we need to pass them into the PDF file by appending <AutoText text="#search="query""/> to the end of the document link. We need to create the link ourselves rather than using <gsf:link type="source"/>in the format statement. </Text>1465 <Text id="fw-24c-3">To highlight the query terms in a PDF document, we need to pass them into the PDF file by appending <AutoText text="#search="query""/> to the end of the document link. We need to create the link ourselves rather than using <Format><gsf:link type="source"/></Format> in the format statement. </Text> 1466 1466 <Text id="fw-24d-3"><AutoText text="PDFPlugin"/> saves each PDF file in a unique directory for that document, and we can use</Text> 1467 1467 <Format><gsf:metadata name="httpPath" type="collection"/>/index/assoc/<gsf:metadata name="archivedir"/>/<gsf:metadata name="srclinkFile"/></Format> 1468 1468 <Text id="fw-24e-3">to refer to the PDF source file. 1469 The search terms can be found in the "q" cgi parameter. You can access this using <gsf:cgi-param name="q"/>.</Text>1469 The search terms can be found in the "q" cgi parameter. You can access this using <Format><gsf:cgi-param name="q"/></Format>.</Text> 1470 1470 </NumberedItem> 1471 1471 <NumberedItem> … … 1685 1685 </NumberedItem> 1686 1686 <NumberedItem> 1687 <Text id="fw-24c-3">To highlight the query terms in a PDF document, we need to pass them into the PDF file by appending <AutoText text="#search="query""/> to the end of the document link. We need to create the link ourselves rather than using <gsf:link type="source"/>in the format statement. </Text>1687 <Text id="fw-24c-3">To highlight the query terms in a PDF document, we need to pass them into the PDF file by appending <AutoText text="#search="query""/> to the end of the document link. We need to create the link ourselves rather than using <Format><gsf:link type="source"/></Format> in the format statement. </Text> 1688 1688 <Text id="fw-24d-3"><AutoText text="PDFPlugin"/> saves each PDF file in a unique directory for that document, and we can use</Text> 1689 1689 <Format><gsf:metadata name="httpPath" type="collection"/>/index/assoc/<gsf:metadata name="archivedir"/>/<gsf:metadata name="srclinkFile"/></Format> 1690 1690 <Text id="fw-24e-3">to refer to the PDF source file. 1691 The search terms can be found in the "q" cgi parameter. You can access this using <gsf:cgi-param name="q"/>.</Text>1691 The search terms can be found in the "q" cgi parameter. You can access this using <Format><gsf:cgi-param name="q"/></Format>.</Text> 1692 1692 </NumberedItem> 1693 1693 <NumberedItem> … … 2197 2197 </NumberedItem> 2198 2198 <NumberedItem> 2199 <Text id="0452">The <MajorVersion number="2">search </MajorVersion><MajorVersion number="3"><AutoText text="form search"/></MajorVersion> pageincludes a pulldown menu that allows you to select one of these partitions for searching. For example, try searching the <i>relatives</i> partition for <i>mary</i> and then search the <i>monarchs</i> partition for the same thing.</Text>2199 <Text id="0452">The <MajorVersion number="2">search page</MajorVersion><MajorVersion number="3"><AutoText text="search"/> section</MajorVersion> includes a pulldown menu that allows you to select one of these partitions for searching. For example, try searching the <i>relatives</i> partition for <i>mary</i> and then search the <i>monarchs</i> partition for the same thing.</Text> 2200 2200 </NumberedItem> 2201 2201 <NumberedItem> … … 2667 2667 <Content> 2668 2668 <NumberedItem> 2669 <Text id="0424">Open up your <b>tudor</b> collection, and in the <AutoText key="glidict::GUI.Gather"/> panel inspect the files you dragged into it. The first folder is <Path>englishhistory.net</Path>, which opens up to reveal <Path>tudor</Path>, and so on. The files represent a complete sweep of the pages (and supporting images) that constitute the <i>Tudor citizens</i> section of the <i>englishhistory.net</i> web site. They were downloaded from the web in a way that preserved the structure of the original site. This allows any page's original URL to be reconstructed from the folder hierarchy.</Text>2669 <Text id="0424">Open up your <b>tudor</b> collection, and in the <AutoText key="glidict::GUI.Gather"/> panel inspect the files you dragged into it. The first folder is <Path>englishhistory.net</Path>, which opens up to reveal <Path>tudor</Path>, and so on. The files represent a complete sweep of the pages (and supporting images) that constitute the <i>Tudor</i> section of the <i>englishhistory.net</i> web site. They were downloaded from the web in a way that preserved the structure of the original site. This allows any page's original URL to be reconstructed from the folder hierarchy.</Text> 2670 2670 </NumberedItem> 2671 2671 <NumberedItem> … … 3644 3644 <gsf:template match="classifierNode[@classifierStyle = 'VList']"><br /> 3645 3645 <Tab n="2"/>...<br /> 3646 <Tab n="2"/><gsf:metadata name="Title"/><br /> 3646 <Tab n="2"/><gsf:link type="classifier"><br /> 3647 <Tab n="3"/><gsf:metadata name="Title"/><br /> 3648 <Tab n="2"/></gsf:link><br /> 3647 3649 <Tab n="1"/></td><br /> 3648 3650 <highlight><Tab n="1"/><td valign="top"><br /> … … 3655 3657 <Text id="0609"><b>Preview</b> the result (you don't need to build the collection.) Bookshelves in the titles and browse classifiers should show how many documents they contain.</Text> 3656 3658 </NumberedItem> 3659 <!-- 3657 3660 <Heading> 3658 3661 <Text id="0612a">Adding a Phind phrase browser</Text> … … 3665 3668 <Text id="0612b"><b>Build</b> the collection again and <b>preview</b> it. Select the new <MajorVersion number="2"><AutoText key="coredm::_Global:labelPhrase_"/></MajorVersion><MajorVersion number="3"><AutoText key="gs3::core_servlet_dictionary::PhindApplet.name" /></MajorVersion> option from the navigation bar. Enter a single word in the text box, such as <AutoText text="band" type="quotes"/>. The phrase browser will present you with phrases found in the collection containing the search term. This can provide a useful way of browsing a very large collection. Note that even though it is called a phrase browser, only single terms can be used as the starting point for browsing.</Text> 3666 3669 </NumberedItem> 3670 --> 3667 3671 <Heading> 3668 3672 <Text id="0612a-1">Branding the collection with an image</Text> … … 4024 4028 <Text id="0690a"><MajorVersion number="2">Refresh in the web browser to view</MajorVersion><MajorVersion number="3"><b>Preview</b></MajorVersion> the new <MajorVersion number="2"><AutoText key="coredm::_Global:labelTitle_"/></MajorVersion><MajorVersion number="3"><AutoText key="gs3::metadata_names::Title.buttonname" /></MajorVersion> list.</Text> 4025 4029 <Text id="0687c">As a consequence of using the <AutoText text="bookshelf_type"/> option of the <AutoText text="List"/> classifier, bookshelf icons appear when titles are browsed. This revised format statement has the effect of specifying in brackets how many items are contained within a bookshelf<MajorVersion number="3"> for classifier nodes</MajorVersion>. <MajorVersion number="2">It works by exploiting the fact that only bookshelf icons define <Format>[numleafdocs]</Format> metadata.</MajorVersion> For document nodes, Title is not displayed. Instead, Volume, Number and Date information are displayed.</Text> 4026 <Text id="0687d"> You may notice that the <AutoText text="Titles"/> browser shows the volume numbers in inverse order. To correct this, in the <AutoText key="glidict::GUI.Design"/> Pane, under <AutoText key="glidict::CDM.GUI.Classifiers"/>, configure the <AutoText text="titles" /> <AutoText text="List" /> classifier. Tick <AutoText text="sort_leaf_nodes_using"/> and set the metadata to <Format>ex.Volume</Format>. Rebuilding now will ensure the <i>ex.Volume</i> Number of each newspaper are listed in numeric order. This has the effect of also sorting the <i>ex.Number</i> value for each <i>ex.Volume</i>.</Text>4030 <Text id="0687d"><MajorVersion number="2">You may notice that the <AutoText text="Titles"/> browser shows the volume numbers in inverse order. To correct this, in</MajorVersion><MajorVersion number="3">In</MajorVersion> the <AutoText key="glidict::GUI.Design"/> Pane, under <AutoText key="glidict::CDM.GUI.Classifiers"/>, configure the <AutoText text="titles" /> <AutoText text="List" /> classifier. Tick <AutoText text="sort_leaf_nodes_using"/> and set the metadata to <Format>ex.Volume|ex.Number</Format>. Rebuilding now will ensure the <i>ex.Volume</i> Number of each newspaper are listed in numeric order. This has the effect of also sorting the <i>ex.Number</i> value for each <i>ex.Volume</i>.</Text> 4027 4031 </NumberedItem> 4028 4032 <Heading> … … 4635 4639 </NumberedItem> 4636 4640 <NumberedItem> 4637 <Text id="oaiserver-14">Although the data transmitted over OAI is in the form of XML, Greenstone uses a stylesheet to transform that XML response into a user-friendly, structured web page that you see when you perform the <AutoText text="Identify"/> request (as happens when you visit the <AutoText text="verb=Identify" type="italics"/> response page). This allows <AutoText text="Identify" type="italics"/> and other verbs in the OAI specification to be shown in the main Greenstone OAI Server pages as link buttons. You can see these verbs represented in the main Greenstone <MajorVersion number="2"><AutoText text="oaiserver.cgi" type="italics"/> (or <AutoText text="oaiserver.cgi?verb=Identify" type="italics"/>)</MajorVersion><MajorVersion number="3"><AutoText text="oaiserver" type="italics"/> (or <AutoText text="oaiserver?verb=Identify" type="italics"/>)</MajorVersion> page as a row of buttonlinks starting with "Identify", displayed at the top and in the lower part of the page.</Text>4641 <Text id="oaiserver-14">Although the data transmitted over OAI is in the form of XML, Greenstone uses a stylesheet to transform that XML response into a user-friendly, structured web page that you see when you perform the <AutoText text="Identify"/> request (as happens when you visit the <AutoText text="verb=Identify" type="italics"/> response page). This allows <AutoText text="Identify" type="italics"/> and other verbs in the OAI specification to be shown in the main Greenstone OAI Server pages as a row of links. You can see these verbs represented in the main Greenstone <MajorVersion number="2"><AutoText text="oaiserver.cgi" type="italics"/> (or <AutoText text="oaiserver.cgi?verb=Identify" type="italics"/>)</MajorVersion><MajorVersion number="3"><AutoText text="oaiserver" type="italics"/> (or <AutoText text="oaiserver?verb=Identify" type="italics"/>)</MajorVersion> page as a row of links starting with "Identify", displayed at the top and in the lower part of the page.</Text> 4638 4642 <Text id="oaiserver-15">Clicking on the links will execute that verb as a request and return the response from your Greenstone OAI server as a structured web page. Try clicking on all the button links.</Text> 4639 4643 </NumberedItem>
Note:
See TracChangeset
for help on using the changeset viewer.
