en:user:urls
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:user:urls [2014/04/13 23:52] – external edit 127.0.0.1 | en:user:urls [2017/02/19 23:13] (current) – removed kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== URLs ====== | ||
- | |||
- | <TABAREA tabs=" | ||
- | <TAB> | ||
- | URL's are greatly simplified in Greenstone3. Using URL rewriting, Greenstone3' | ||
- | short, and informative. For example, the URL for a document page in a Greenstone2 collection | ||
- | will look something like this: | ||
- | |||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | In Greenstone3, | ||
- | |||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | So, as this example shows, you can easily access any document in any collection in a library | ||
- | simply by navigating to ''< | ||
- | |||
- | \\ | ||
- | |||
- | |||
- | |||
- | |||
- | ^Library URL patterns^Description^ | ||
- | |//All URL patterns are preceded by ''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |||
- | |||
- | ''< | ||
- | |||
- | By default, The Greenstone3 server runs on ''< | ||
- | ''< | ||
- | |||
- | |||
- | ==== context ==== | ||
- | context ' | ||
- | by default '' | ||
- | copies this the file from '' | ||
- | |||
- | < | ||
- | <!-- [line 1287] set up the greenstone3 context --> | ||
- | <copy file=" | ||
- | < | ||
- | <filter token=" | ||
- | <filter token=" | ||
- | <filter token=" | ||
- | </ | ||
- | </ | ||
- | </ | ||
- | |||
- | To change the context, change variable in '' | ||
- | |||
- | |||
- | < | ||
- | |||
- | # The context name of your GS3 digital library. By default this will be " | ||
- | # Ensure this has a value. If you change this multiple times, you need to remove the old versions | ||
- | # of < | ||
- | # does not contain previous | ||
- | custom.context=greenstone3 | ||
- | </ | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ===== Arguments ===== | ||
- | |descendants=1|On hierarchical browse pages, this will display with page with all levels of all sections expanded| | ||
- | |o=xml|Displays the raw information coming from the Message Router.| | ||
- | |o=xmlfinal|Displays the information coming from the Message Router after the second config_format pass.| | ||
- | |o=skindoc|Simplified Skin XSL with Expanded GSF statements appended.| | ||
- | |o=skinandlib|An XML document with a root element called skinAndLibraryXsl and the two children skinXsl and libraryXsl. The libraryXsl, which already includes util.xsl, is merely appended.| | ||
- | |o=skinandlibdoc|The result of applying preprocess.xsl to skinandlib produces this stylesheet which is the final XSL document that will be applied to the XML data returned from the message router.| | ||
- | |formatedit=on|Web interface editor for editing Greenstone3 format statements.| | ||
- | |a=s& | ||
- | |||
- | '' | ||
- | Find more information on arguments: | ||
- | '' | ||
- | |||
- | |||
- | ===== Additional Resources ===== | ||
- | * [[en: | ||
- | |||
- | </ | ||
- | <!-- ############################################################################## | ||
- | ################################################################################### | ||
- | ################################################################################ | ||
- | <TAB> | ||
- | |||
- | |||
- | |||
- | ===== Actions and Arguments ===== | ||
- | |||
- | CGI arguments encode the parameters of each page, for instance, what kind of page to display, what query to carry out etc. This page describes the common actions and arguments used by the Greenstone library server. | ||
- | |||
- | '' | ||
- | |||
- | |||
- | You can set the default value of any cgi argument in the Greenstone\etc\main.cfg file. Add a line like | ||
- | < | ||
- | | ||
- | </ | ||
- | This will set the default value of argument ' | ||
- | |||
- | ==== a=p: Page action==== | ||
- | Displays ' | ||
- | |||
- | ^Argument^Description^ | ||
- | | p | page type: home, about, help, preferences| | ||
- | |||
- | |||
- | ==== a=q: Query action==== | ||
- | Displays search form and results, and optionally search history. Many of the options are set from the preferences page. | ||
- | |||
- | ^Argument^Description^ | ||
- | |q | query string| | ||
- | |c | current collection| | ||
- | |h | index to search (MG collections only)| | ||
- | |j | subcollection index (if collection has been partitioned)| | ||
- | |n | language index (if collection has been partitioned based on language)| | ||
- | |t | search type - if b=0, 0=all, 1=some. if b=1, 0=boolean, 1=ranked| | ||
- | |b | search mode - 0=simple, 1=advanced| | ||
- | |k | casefolding - 0=off (case must match), 1=on (ignore case)| | ||
- | |s | stemming - 0=off (whole word must match), 1=on (ignore word endings)| | ||
- | |m | max number of documents to return in search results| | ||
- | |o | how many documents to display per page of search results| | ||
- | |r | which result number to start from for the current page of results| | ||
- | |ccs | cross collection searching - 0=off, 1=on| | ||
- | |cc | comma separated list of collections to search if cross collection search is enabled| | ||
- | |hd | display X number of search history records. if set to 0, search history is not displayed| | ||
- | |qb | query box type - 0=regular, 1=large| | ||
- | |ifl | I feel lucky - go directly to the first matching document instead of displaying the search results| | ||
- | |ct | collection type - 0=MG, 1=MGPP, 2=Lucene| | ||
- | |||
- | The following arguments are only available for MGPP and Lucene collections, | ||
- | |||
- | ^Argument^Description^ | ||
- | |g | granularity, | ||
- | |fqf | index to search in. used instead of h arg for MGPP and Lucene plain searching| | ||
- | |qt | current query type - 0=plain, 1=form| | ||
- | |qto | available query types - 1=plain only, 2=form only, 3=both plain and form| | ||
- | |qf | query form type - 0=simple, 1=advanced| | ||
- | |fqn | query form number - number of boxes to display in the form| | ||
- | |fqf | query form fields - comma separated list of field selections| | ||
- | |fqv | query form values - comma separated list of query values| | ||
- | |fqs | query form stemming - comma separated list of stem settings (advanced form only)| | ||
- | |fqk | query form casefolding - comma separated list of casefold settings (advanced form only)| | ||
- | |fqc | query form combiners - comma separated list of boolean operators which are used to combine the query terms (AND, | ||
- | |fqa | query form advanced query - run the query specified by the q argument instead of generating the query based on the fq- arguments (advanced query)| | ||
- | |||
- | ====a=d: Document action==== | ||
- | Used for displaying documents and classifiers | ||
- | |||
- | ^Argument^Description^ | ||
- | |d | the document identifier to display| | ||
- | |cl | the classifier identifier - will be displayed if d is empty, otherwise it is used to record where in a classifier the document was entered from| | ||
- | |gc | expand/ | ||
- | |gt | expand/ | ||
- | |gp | goto page - used by page type document navigation| | ||
- | |hl | search term highlighting - 0=off, 1=on| | ||
- | |x | detach - x=1 means that the page will open in a new window| | ||
- | |xx | all document pages should be detached| | ||
- | |dm | date metadata - indicates the metadata type (e.g. ex.Date, dc.Date) that has been used to build a Date classifier - this is used in the special DateList formatting| | ||
- | |||
- | |||
- | ====a=extlink: | ||
- | Handles displaying documents which are external web pages | ||
- | |||
- | ^Argument^Description^ | ||
- | |el | external link preference - prompt=indicate to the user that they are about to leave the library, direct=go straight to the page| | ||
- | |d | document ID - of page that the link is in| | ||
- | |href | the external URL to go to| | ||
- | |rl | link is relative - what does this mean???| | ||
- | |||
- | |||
- | ===== Remove External Link page ===== | ||
- | |||
- | Clicking on a link to an external resource from a Greenstone document takes the user to an intermediate page that says something like the following: | ||
- | " | ||
- | The link you have selected is external to any of your currently selected | ||
- | | ||
- | the Web, you can go forward to this page; otherwise use your browsers " | ||
- | | ||
- | |||
- | To get rid of this intermediate page, add the following to greenstone/ | ||
- | < | ||
- | | ||
- | </ | ||
- | |||
- | |||
- | ===== Redirecting a link to Greenstone ===== | ||
- | |||
- | <!-- id:276 -->You may want to redirect a more convenient URL to your Greenstone cgi program. For example, on our system the URL // http: | ||
- | |||
- | < | ||
- | Redirect /index.html http:// | ||
- | </ | ||
- | |||
- | <!-- id:277 -->Then you will reach your digital library system directly from the URL // http: | ||
- | |||
- | < | ||
- | Redirect /greenstone http:// | ||
- | </ | ||
- | |||
- | <!-- id:278 -->If your computer doesn' | ||
- | |||
- | <!-- id:279 --> | ||
- | |||
- | |||
- | </ | ||
- | </ | ||
- | |||
- | |||
en/user/urls.1397433133.txt.gz · Last modified: 2016/09/26 23:01 (external edit)