- Timestamp:
- 2007-05-25T16:12:13+12:00 (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl-documentation/manuals/xml-source/en/Develop_en.xml
r13781 r14099 60 60 </Bullet> 61 61 </BulletList> 62 </Content> 63 </Section> 64 <Section id="copyright"> 65 <Title> 66 <Text id="copyright-title">Copyright</Text> 67 </Title> 68 <Content> 69 <Text id="right-text-1">Copyright 2002 2003 2004 2005 2006 2007 by the <Link url="http://www.nzdl.org">New Zealand Digital Library Project</Link> at <Link url="http://www.waikato.ac.nz">the University of Waikato</Link>, New Zealand.</Text> 70 <Text id="right-text-2">Permission is granted to copy, distribute and/or modify this document under the terms of the <Link url="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</Link>, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled <Link url="http://greenstonewiki.cs.waikato.ac.nz/wiki/gsdoc/GNUFDL.html">âGNU Free Documentation License.â</Link></Text> 62 71 </Content> 63 72 </Section> … … 2659 2668 <th width="283"> 2660 2669 <Text id="657">Format of the text to be displayed on a document page: default</Text> 2661 <CodeLine> Â Â Â Â<i><center><table width=537></i></CodeLine>2662 <CodeLine><i> Â Â Â Â Â Â<tr><td>[Text]</td></tr></i></CodeLine>2663 <CodeLine><i> Â Â Â Â Â Â</table></center></i></CodeLine>2670 <CodeLine><i><center><table width=537></i></CodeLine> 2671 <CodeLine><i><tr><td>[Text]</td></tr></i></CodeLine> 2672 <CodeLine><i></table></center></i></CodeLine> 2664 2673 </th> 2665 2674 </tr> … … 3959 3968 </TableContent> 3960 3969 </Table> 3961 <Text id="970"> <CrossRef target="Table" ref="list_of_protocol_calls"/> lists the function calls to the protocol, with a summary for each entry. The examples in Section <CrossRef target="Section" ref="how_the_conceptual_framework_fits_together"/> covered most of these. Functions not previously mentioned are <i>has_collection()</i>, <i>ping()</i>, <i>get_protocol_name()</i> and <i>get_filteroptions()</i>. The first two provide yes/no answers to the questions âdoes the collection exists on this server?â and âis it running?â respectively. The purpose of the other two is to support multiple protocols within an architecture that is distributed over different computers, not just the null-protocol based single executable described here. One of these distinguishes which protocol is being used. The other lets a receptionist interrogate a collection server to find what options are supported, and so dynamically configure itself to take full advantage of the services offered by a particular server.</Text>3970 <Text id="970">Table <CrossRef target="Table" ref="list_of_protocol_calls"/> lists the function calls to the protocol, with a summary for each entry. The examples in Section <CrossRef target="Section" ref="how_the_conceptual_framework_fits_together"/> covered most of these. Functions not previously mentioned are <i>has_collection()</i>, <i>ping()</i>, <i>get_protocol_name()</i> and <i>get_filteroptions()</i>. The first two provide yes/no answers to the questions âdoes the collection exists on this server?â and âis it running?â respectively. The purpose of the other two is to support multiple protocols within an architecture that is distributed over different computers, not just the null-protocol based single executable described here. One of these distinguishes which protocol is being used. The other lets a receptionist interrogate a collection server to find what options are supported, and so dynamically configure itself to take full advantage of the services offered by a particular server.</Text> 3962 3971 <Figure id="null_protocol_api"> 3963 3972 <Title> … … 4704 4713 <CodeLine>Statically construct Receptionist</CodeLine> 4705 4714 <CodeLine>Statically construct NullProtocol</CodeLine> 4706 <CodeLine>Establish the value for 'gsdlhome'by reading gsdlsite.cfg</CodeLine>4707 <CodeLine>Foreach directory in GSDLHOME/collect that isn 't "modelcol":</CodeLine>4708 <CodeLine> 4709 <CodeLine> 4710 <CodeLine> 4711 <CodeLine> 4712 <CodeLine> 4713 <CodeLine> 4714 <CodeLine> 4715 <CodeLine> 4716 <CodeLine> Configure Collection with 'collection'</CodeLine>4717 <CodeLine> Passing 'collection'value on to Filters and Sources:</CodeLine>4718 <CodeLine> Configure Receptionist with 'collectinfo':</CodeLine>4719 <CodeLine> Passing 'collectinfo'value on to Actions, Protocols, and Browsers:</CodeLine>4715 <CodeLine>Establish the value for âgsdlhomeâ by reading gsdlsite.cfg</CodeLine> 4716 <CodeLine>Foreach directory in GSDLHOME/collect that isnât "modelcol":</CodeLine> 4717 <CodeLine>Â Add directory name (now treated as collection name) to NullProtocol:</CodeLine> 4718 <CodeLine>Â Â Â Dynamically construct Collection</CodeLine> 4719 <CodeLine>Â Â Â Dynamically construct Gdbm class</CodeLine> 4720 <CodeLine>Â Â Â Dynamically construct the Null Filter</CodeLine> 4721 <CodeLine>Â Â Â Dynamically construct the Browse Filter</CodeLine> 4722 <CodeLine>Â Â Â Dynamically construct MgSearch</CodeLine> 4723 <CodeLine>Â Â Â Dynamically construct the QueryFilter</CodeLine> 4724 <CodeLine>Â Â Â Dynamically construct the MgGdbmSource</CodeLine> 4725 <CodeLine>Â Â Â Configure Collection with âcollectionâ</CodeLine> 4726 <CodeLine>Â Â Â Â Â Passing âcollectionâ value on to Filters and Sources:</CodeLine> 4727 <CodeLine>Configure Receptionist with âcollectinfoâ:</CodeLine> 4728 <CodeLine>Â Â Â Â Â Passing âcollectinfoâ value on to Actions, Protocols, and Browsers:</CodeLine> 4720 4729 <CodeLine>Add NullProtocol to Receptionist</CodeLine> 4721 4730 <CodeLine>Add in UTF-8 converter</CodeLine> … … 4723 4732 <CodeLine>Add in Arabic converter</CodeLine> 4724 4733 <CodeLine>Foreach Action:</CodeLine> 4725 <CodeLine> 4726 <CodeLine> 4734 <CodeLine>Â Statically construct Action</CodeLine> 4735 <CodeLine>Â Add Action to Receptionist</CodeLine> 4727 4736 <CodeLine>Foreach Browsers:</CodeLine> 4728 <CodeLine> 4729 <CodeLine> 4737 <CodeLine>Â Statically construct Browser</CodeLine> 4738 <CodeLine>Â Add Browser to Receptionist</CodeLine> 4730 4739 <CodeLine>Call function cgiwrapper:</CodeLine> 4731 <CodeLine> 4732 <CodeLine> 4733 <CodeLine> 4734 <CodeLine> Configure Receptionist with 'collection'</CodeLine>4735 <CodeLine> Passing 'collection'value on to Actions, Protocols, and Browsers:</CodeLine>4736 <CodeLine> NullProtocol not interested in 'collection'</CodeLine>4737 <CodeLine> Configure Receptionist with 'httpimg'</CodeLine>4738 <CodeLine> Passing 'httpimg'value on to Actions, Protocols, and Browsers:</CodeLine>4739 <CodeLine> NullProtocol passing 'httpimg'on to Collection</CodeLine>4740 <CodeLine> Passing 'httpimg'value on to Filters and Sources:</CodeLine>4741 <CodeLine> Configure Receptionist with 'gwcgi'</CodeLine>4742 <CodeLine> Passing 'gwcgi'value on to Actions, Protocols, and Browsers:</CodeLine>4743 <CodeLine> NullProtocol passing 'gwcgi'on to Collection</CodeLine>4744 <CodeLine> Passing 'gwcgi'value on to Filters and Sources:</CodeLine>4745 <CodeLine> 4746 <CodeLine> Configure Recptionist with 'gsdlhome'</CodeLine>4747 <CodeLine> Passing 'gsdlhome'value on to Actions, Protocols, and Browsers:</CodeLine>4748 <CodeLine> NullProtocol passing 'gsdlhome'on to Collection</CodeLine>4749 <CodeLine> Passing 'gsdlhome'value on to Filters and Sources:</CodeLine>4750 <CodeLine> 4751 <CodeLine> ... and so on for all entries in gsdlsite.cfg</CodeLine>4752 <CodeLine> 4753 <CodeLine> Confiugre Recptionist with ...</CodeLine>4754 <CodeLine> 4755 <CodeLine> 4756 <CodeLine> 4757 <CodeLine> 4758 <CodeLine> 4759 <CodeLine> Configure Receptionist with 'collectdir'</CodeLine>4760 <CodeLine> Passing 'collectdir'value on to Actions, Protocols, and Browsers:</CodeLine>4761 <CodeLine> NullProtocol not interested in 'collectdir'</CodeLine>4762 <CodeLine> 4763 <CodeLine> 4764 <CodeLine> 4765 <CodeLine> 4766 <CodeLine> 4767 <CodeLine> 4768 <CodeLine> 4769 <CodeLine> Reading Collection's build.cfg</CodeLine>4770 <CodeLine> Reading Collection's collect.cfg</CodeLine>4771 <CodeLine> Configure Collection with 'creator'</CodeLine>4772 <CodeLine> Passing 'creator'value on to Filters and Sources:</CodeLine>4773 <CodeLine> Configure Collection with 'maintainer'</CodeLine>4774 <CodeLine> Passing 'maintainer'value on to Filters and Sources:</CodeLine>4775 <CodeLine> 4776 <CodeLine> 4777 <CodeLine> 4778 <CodeLine> 4779 <CodeLine> 4780 <CodeLine> 4781 <CodeLine> 4782 <CodeLine> 4740 <CodeLine>Â =================</CodeLine> 4741 <CodeLine>Â Configure objects</CodeLine> 4742 <CodeLine>Â =================</CodeLine> 4743 <CodeLine>Â Configure Receptionist with âcollectionâ</CodeLine> 4744 <CodeLine>Â Â Â Passing âcollectionâ value on to Actions, Protocols, and Browsers:</CodeLine> 4745 <CodeLine>Â Â Â NullProtocol not interested in âcollectionâ</CodeLine> 4746 <CodeLine>Â Configure Receptionist with âhttpimgâ</CodeLine> 4747 <CodeLine>Â Â Â Passing âhttpimgâ value on to Actions, Protocols, and Browsers:</CodeLine> 4748 <CodeLine>Â Â Â NullProtocol passing âhttpimgâ on to Collection</CodeLine> 4749 <CodeLine>Â Â Â Passing âhttpimgâ value on to Filters and Sources:</CodeLine> 4750 <CodeLine>Â Configure Receptionist with âgwcgiâ</CodeLine> 4751 <CodeLine>Â Â Â Passing âgwcgiâ value on to Actions, Protocols, and Browsers:</CodeLine> 4752 <CodeLine>Â Â Â NullProtocol passing âgwcgiâ on to Collection</CodeLine> 4753 <CodeLine>Â Â Â Passing âgwcgiâ value on to Filters and Sources:</CodeLine> 4754 <CodeLine>Â Reading in site configuration file gsdlsite.cfg</CodeLine> 4755 <CodeLine>Â Â Â Configure Recptionist with âgsdlhomeâ</CodeLine> 4756 <CodeLine>Â Â Â Â Â Passing âgsdlhomeâ value on to Actions, Protocols, and Browsers:</CodeLine> 4757 <CodeLine>Â Â Â Â Â NullProtocol passing âgsdlhomeâ on to Collection</CodeLine> 4758 <CodeLine>Â Â Â Â Â Â Â Passing âgsdlhomeâ value on to Filters and Sources:</CodeLine> 4759 <CodeLine>Â Â Â Configure Recptionist with ...</CodeLine> 4760 <CodeLine>Â Â Â ... and so on for all entries in gsdlsite.cfg </CodeLine> 4761 <CodeLine>Â Reading in main configuration file main.cfg</CodeLine> 4762 <CodeLine>Â Â Â Configure Recptionist with ...</CodeLine> 4763 <CodeLine>Â Â Â ... and so on for all entries in main.cfg</CodeLine> 4764 <CodeLine>Â ====================</CodeLine> 4765 <CodeLine>Â Initialising objects</CodeLine> 4766 <CodeLine>Â ====================</CodeLine> 4767 <CodeLine>Â Initialise the Receptionist</CodeLine> 4768 <CodeLine>Â Â Â Configure Receptionist with âcollectdirâ</CodeLine> 4769 <CodeLine>Â Â Â Â Â Passing âcollectdirâ value on to Actions, Protocols, and Browsers:</CodeLine> 4770 <CodeLine>Â Â Â Â Â NullProtocol not interested in âcollectdirâ</CodeLine> 4771 <CodeLine>Â Â Â Read in Macro files</CodeLine> 4772 <CodeLine>Â Â Â Foreach Actions</CodeLine> 4773 <CodeLine>Â Â Â Â Â Initialise Action</CodeLine> 4774 <CodeLine>Â Â Â Foreach Protocol</CodeLine> 4775 <CodeLine>Â Â Â Â Â Initialise Protocol</CodeLine> 4776 <CodeLine>Â Â Â Â Â When Protocol==NullProtocol:</CodeLine> 4777 <CodeLine>Â Â Â Â Â Â Â Foreach Collection</CodeLine> 4778 <CodeLine>Â Â Â Â Â Â Â Â Â Reading Collectionâs build.cfg</CodeLine> 4779 <CodeLine>Â Â Â Â Â Â Â Â Â Reading Collectionâs collect.cfg</CodeLine> 4780 <CodeLine>Â Â Â Â Â Â Â Â Â Â Â Configure Collection with âcreatorâ</CodeLine> 4781 <CodeLine>Â Â Â Â Â Â Â Â Â Â Â Â Â Passing âcreatorâ value on to Filters and Sources:</CodeLine> 4782 <CodeLine>Â Â Â Â Â Â Â Â Â Â Â Configure Collection with âmaintainerâ</CodeLine> 4783 <CodeLine>Â Â Â Â Â Â Â Â Â Â Â Â Â Passing âmaintainerâ value on to Filters and Sources:</CodeLine> 4784 <CodeLine>Â Â Â Â Â Â Â Â Â Â Â ... and so on for all entries in collect.cfg</CodeLine> 4785 <CodeLine>Â Â Â Foreach Browsers</CodeLine> 4786 <CodeLine>Â Â Â Â Â Initialise Browser</CodeLine> 4787 <CodeLine>Â =============</CodeLine> 4788 <CodeLine>Â Generate page</CodeLine> 4789 <CodeLine>Â =============</CodeLine> 4790 <CodeLine>Â Parse CGI arguments</CodeLine> 4791 <CodeLine>Â Execute designated Action to produce page</CodeLine> 4783 4792 <CodeLine>End.</CodeLine> 4784 4793 </Figure>
Note:
See TracChangeset
for help on using the changeset viewer.
