Ignore:
Timestamp:
2006-03-14T19:08:47+13:00 (18 years ago)
Author:
kjdon
Message:

restructured the help text into many frangments, not just a few. moved lots of markup into the help file. and removed duplicate text: headings were duplicated in the contents, and in the text

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/gsdl/macros/english.dm

    r11221 r11363  
    113113_labelSearch_ {Search}
    114114
     115_labelPoos_ {Poos a-z}
    115116# Dublin Core Metadata Element Set, Version 1.1
    116117_labelTitle_ {Titles A-Z}  # Not true DC, kept for legacy reasons
     
    645646publications (listing is sorted by an unknown field).  }
    646647
    647 _texthelptopics_ {
    648 <h2 align=left>Topics</h2>
    649 <ul>
    650   <li><a href="\#finding-information">_textsimplehelpheading_</a>
    651   _topicreadingdocs_
    652   <li><a href="\#searching">How to search for particular words</a>
    653 <ul>
    654   <li><a href="\#query-terms">Search terms</a>
    655   <li><a href="\#query-type">Query type</a>
    656   <li><a href="\#scope-of-queries">Scope of queries</a>
    657 </ul>
    658   <li><a href="\#preferences">_textchangeprefs_</a>
    659 <ul>
    660   <li><a href="\#col-prefs">Collection preferences</a>
    661   <li><a href="\#lang-prefs">Language preferences</a>
    662   <li><a href="\#pres-prefs">Presentation preferences</a>
    663   <li><a href="\#search-prefs">Search preferences</a>
    664 </ul>
    665 </ul>
    666 }
    667 
    668 # there are 4 versions of this section of the help text.
    669 # which version is used is currently set within the server
    670 # (it should probably use the macro language e.g. [type=book])
    671 # 1 = html (like fao collections) -- section is empty
    672 # 2 = book (like hdl collection) -- macros beginning with book
    673 # 3 = bibliographic (like csbib) -- macros beginning with bib
    674 # 4 = standard (like gberg) -- the default
    675 
    676 _topicreadingdocs_ {<li><a href="\#reading-docs">_textreadingdocs_</a>}
     648
     649_texthelptopicstitle_ {Topics}
    677650
    678651_textreadingdocs_ {How to read the documents}
    679652
    680653_texthelpreadingdocs_ {
    681 <div class="divbar">&nbsp;</div>
    682 <a name="reading-docs"></a>
    683 <h2>_textreadingdocs_</h2>
    684 
    685654<p>You can tell when you have arrived at an individual book or document
    686655because its title, or a photograph of the front cover, appears at the top
     
    705674once.) Finally, when you do a search the words you search for are
    706675highlighted. Click on <i>no highlighting</i> to remove highlighting.</p>
    707 
    708 <p>
    709 <table cellspacing="0" cellpadding="2" border="0">
    710 <tr><td colspan=2><img src="_httpiconbshelf_" border="0"></td><td>Open this bookshelf</td></tr>
    711 <tr><td><img src="_httpiconopenbook_" border="0"></td><td><img
    712 src="_httpiconbook_" border="0"></td><td>Open/close this book</td></tr>
    713 <tr><td colspan=2><img src="_httpiconitext_" border="0"></td><td>View this section of the text</td></tr>
    714 <tr><td><img src="_document:httpiconealltof_" border="0"></td><td><img
    715 src="_document:httpiconetsecof_" border="0"></td><td>Display all text, or not</td></tr>
    716 <tr><td><img src="_document:httpiconeexpcof_" border="0"></td><td><img
    717 src="_document:httpiconeconcof_" border="0"></td><td>Expand table of contents, or not</td></tr>
    718 <tr><td colspan=2><img src="_document:httpiconedtchof_" border="0"></td><td>Open this page in a new window</td></tr>
    719 <tr><td><img src="_document:httpiconehlof_" border="0"></td><td><img
    720 src="_document:httpiconenhlof_" border="0"></td><td>Highlight search terms, or not</td></tr>
    721 <tr><td colspan=2><img src="_httpiconmore_" border="0"></td><td>Click the arrow to go to the next section ...</td></tr>
    722 <tr><td colspan=2><img src="_httpiconless_" border="0"></td><td>... or back to the previous section</td></tr>
    723 </table>
    724 }
     676}
     677
     678# help about the icons
     679_texthelpopenbookshelf_ {Open this bookshelf}
     680_texthelpopenbook_ {Open/close this book}
     681_texthelpviewtextsection_ {View this section of the text}
     682_texthelpexpandtext_ {Display all text, or not}
     683_texthelpexpandcontents_ {Expand table of contents, or not}
     684_texthelpdetachpage_ {Open this page in a new window}
     685_texthelphighlight_ {Highlight search terms, or not}
     686_texthelpsectionarrows_ {Go to the previous/next section}
     687
     688
     689_texthelpsearchingtitle_ {How to search for particular words}
    725690
    726691_texthelpsearching_ {
    727 <h2>How to search for particular words</h2>
    728692<p>
    729693  From the search page, you make a query in these simple steps:<p>
     
    744708  documents returned.  You can change this number by clicking the
    745709  <i>preferences</i> button at the top of the page.<p>
    746 
    747 <div class="divbar">&nbsp;</div>
    748 <a name="query-terms"></a>
    749 <h3>Search terms</h3>
    750 
     710}
     711
     712_texthelpquerytermstitle_ {Search terms}
     713_texthelpqueryterms_ {
    751714<p>Whatever you type into the query box is interpreted as a list of words
    752715called "search terms."  Each term contains nothing but alphabetic characters
     
    760723      <p>will be treated the same as<p>
    761724      <ul><kbd>Agro forestry in the Pacific Islands  Systems for Sustainability  1993 </kbd></ul><p>
    762 
    763 <div class="divbar">&nbsp;</div>
    764 <a name="query-type"></a>
    765 <h3>Query type</h3>
    766 
     725}
     726
     727_texthelpquerytypetitle_ {Query type}
     728_texthelpquerytype_ {
    767729<p>There are two different kinds of query.
    768730
     
    789751whole paragraph.  If you specify only
    790752one term, documents will be ordered by its frequency of occurrence.<p>
    791 _texthelpscope_
    792753}
    793754
    794755_textdatesearch_ {Searching with Dates}
    795756
    796 _texthelpdatesearch_ {<h2>_textdatesearch_</h2>
     757_texthelpdatesearch_ {
    797758Date search lets you find documents that, as well as matching your search
    798759terms, are about events within a certain timeframe.  You can search for
     
    801762you do not have to use dates in your search, if you do not type any dates in it
    802763 is just the same as if the date search didn't exist.<p>
    803 
    804 <div class="divbar">&nbsp;</div>
    805 <a name="datesearch-howto"></a>
    806 <h3>How to use this feature:</h3>
     764}
     765
     766_texthelpdatehowtotitle_ {How to use this feature:}
     767_texthelpdatehowto_ {
    807768<ul>
    808769   <li>To search for documents about a single year:<p>
     
    825786   </ul>   
    826787</ul><p>
    827 
    828 <div class="divbar">&nbsp;</div>
    829 <a name="datesearch-results"></a>
    830 <h3>The way results of your search work</h3>
    831 
     788}
     789
     790_texthelpdateresultstitle_ {The way results of your search work}
     791_texthelpdateresults_ {
    832792Generally speaking a search for documents about the year 1903 will not return documents that, say, reference books written in 1903, just documents about 1903.  However, the way that the documents' dates are found, it will return documents that have a date range (for example 1899-1911) that includes 1903, and also those documents which, as part of their text name the century that 1903 is a part of (for example 20th century or twentieth century).  This means that for some documents, the dates in your search will not actually appear in the document text.  For a range search, all of this applies to every date in the range.<p>
    833793}
     
    835795_textchangeprefs_ {Changing your preferences}
    836796
    837 _texthelppreferences_ {<h2>_textchangeprefs_</h2>
    838 
     797_texthelppreferences_ {
    839798<p>When you click the <i>preferences</i> button at the top of the page you will
    840799be able to change some features of the interface to suit your own requirements.
    841 
    842 <div class="divbar">&nbsp;</div>
    843 <a name="col-prefs"></a>
    844 <h3 align=left>Collection preferences</h3>
    845 
     800}
     801
     802_texthelpcollectionprefstitle_ {Collection preferences}
     803_texthelpcollectionprefs_ {
    846804Some collections comprise several subcollections, which can be searched
    847805independently or together, as one unit.  If so, you can select which
    848806subcollections to include in your searches on the Preferences page.
    849 
    850 <div class="divbar">&nbsp;</div>
    851 <a name="lang-prefs"></a>
    852 <h3 align=left>Language preferences</h3>
    853 
     807}
     808
     809_texthelplanguageprefstitle_ {Language preferences}
     810_texthelplanguageprefs_ {
    854811Each collection has a default presentation language, but you can switch to
    855812a different language if you like.  You can also alter the encoding scheme
     
    860817is particularly useful for visually impaired users who use large screen
    861818fonts or speech synthesizers for output.
    862 
    863 <div class="divbar">&nbsp;</div>
    864 <a name="pres-prefs"></a>
    865 <h3 align=left>Presentation preferences</h3>
    866 
     819}
     820
     821_texthelppresentationprefstitle_ {Presentation preferences}
     822_texthelppresentationprefs_ {
    867823Depending on the particular collection, there may be several options you can
    868824set that control the presentation.
     
    877833Results" page take you straight to the actual URL in question, rather than to
    878834the digital library's copy of the page.
    879 
    880 <div class="divbar">&nbsp;</div>
    881 <a name="search-prefs"></a>
    882 <h3 align=left>Search preferences</h3>
     835}
     836
     837_texthelpsearchprefstitle_ {Search preferences}
     838_texthelpsearchprefs_ {
    883839<p>Two pairs of buttons control the kind of text matching in the searches that
    884840you make. The first set (labeled "case differences") controls whether upper and
     
    910866_textsimplehelpheading_ {How to find information in the _collectionname_ collection}
    911867
     868_texthelpscopetitle_ {Scope of queries}
    912869_texthelpscope_ {
    913 <div class="divbar">&nbsp;</div>
    914 <a name="scope-of-queries"></a>
    915 <h3 align=left>Scope of queries</h3>
    916 
    917870<p>
    918871In most collections you can choose different indexes to search. For example, there might
Note: See TracChangeset for help on using the changeset viewer.