Changeset 7018

Show
Ignore:
Timestamp:
22/10/10 18:59:56 (19 months ago)
Author:
westram
Message:
  • create a simple index page (to invite google to search all pages)
    • link to index page from all pages
  • no longer generate unused files 'helpfiles.lst' and '_index.html'
  • write backlink into comments of generated xml
  • fixed a few helppages which refused to get scanned by generate_index.pl
  • updated depends
Location:
trunk
Files:
1 added
9 modified

Legend:

Unmodified
Added
Removed

  • trunk/DIST/Makefile

    r6868 r7018  
    5151DI_clusters.o: $(ARBHOME)/INCLUDE/AP_filter.hxx 
    5252DI_clusters.o: $(ARBHOME)/INCLUDE/AP_seq_dna.hxx 
    53 DI_clusters.o: $(ARBHOME)/INCLUDE/AP_seq_simple_pro.hxx 
     53DI_clusters.o: $(ARBHOME)/INCLUDE/AP_seq_protein.hxx 
    5454DI_clusters.o: $(ARBHOME)/INCLUDE/AP_sequence.hxx 
    5555DI_clusters.o: $(ARBHOME)/INCLUDE/arb_assert.h 

  • trunk/HELP_SOURCE/Makefile

    r7016 r7018  
    1414HTML_LOCATION=../lib/help_html 
    1515HLP_DEST=../lib/help 
     16HELP_INDEX_NAME = aaa_help_index 
    1617 
    1718# needed tools: 
    … …  
    3738                @echo --------------------------------------------------- [xml 2 html] 
    3839                time $(MAKE) html 
    39                 $(MAKE) html_index 
    4040 
    4141$(HLP_DEST)/FORM.hlp: $(HLP_SOURCE)/FORM.hlp 
    … …  
    6767 
    6868# -------------------------------------------------------------------------------- 
     69 
     70HELP_INDEX_XML = $(XML_LOCATION)/$(HELP_INDEX_NAME).xml 
    6971 
    7072#OLD_HELP= oldhelp/importift.hlp 
    … …  
    8890XML_TMP=$(OLD_HELP:%.hlp=%.xml) 
    8991XML_TMP2=$(XML_TMP:$(HLP_SOURCE)/%=$(XML_LOCATION)/%) 
    90 XML=$(XML_TMP2:$(HLP_GENERATED)/%=$(XML_LOCATION)/%) 
     92XML=$(XML_TMP2:$(HLP_GENERATED)/%=$(XML_LOCATION)/%)  
    9193 
    9294XML_DEPEND=xml.stamp# xml files are rebuild if this stamp is recreated 
    9395DTD=arb_help.dtd 
    9496 
     97# @@@ reactivate again: 
    9598$(XML) : $(XML_DEPEND)  $(QUIETLY) 
     99#$(XML) :  $(QUIETLY) 
    96100 
    97101#$(XML) : $(XML_DEPEND) Makefile $(QUIETLY) 
    98102 
    99 xml : $(XML) 
     103 
     104$(HELP_INDEX_XML): $(OLD_HELP_ALL) $(XML) ./generate_index.pl Makefile  
     105        ./generate_index.pl $(HELP_INDEX_NAME).xml $(XML_LOCATION) > $(HELP_INDEX_XML) 
     106 
     107xml : $(XML) $(HELP_INDEX_XML) 
    100108 
    101109dump: 
    … …  
    107115                                  echo $(HLP_GENERATED)/$(<F):1: other occurrence \ 
    108116                                  && false ) 
    109                 @arb_help2xml $< $@ 
     117                @$(HELP2XML) $< $@ 
    110118                @$(VALIDATE) $@ 
    111119 
    … …  
    115123                                  echo $(HLP_SOURCE)/$(<F):1: other occurrence \ 
    116124                                  && false ) 
    117                 @arb_help2xml $< $@ 
     125                @$(HELP2XML) $< $@ 
    118126                @$(VALIDATE) $@ 
    119127 
    120  
    121 HTML_TMP=$(XML:%.xml=%.html) 
    122 HTML=$(HTML_TMP:$(XML_LOCATION)/%=$(HTML_LOCATION)/%) 
     128$(HTML_LOCATION)/help_index.html : $(HELP_INDEX_XML) 
     129 
     130HTML_TMP=$(XML:%.xml=%.html)  
     131HTML=$(HTML_TMP:$(XML_LOCATION)/%=$(HTML_LOCATION)/%)  
    123132 
    124133HELP_TMP=$(XML:%.xml=%.hlp) 
    … …  
    194203# -------------------------------------------------------------------------------- 
    195204 
    196 HTML_IDX = _index.html 
    197  
    198 html.list: $(HTML) 
    199                 @find $(HTML_LOCATION) -name "*.html" >$@ 
    200  
    201 $(HTML_IDX) : html.list 
    202                 @echo '<HTML><HEAD><TITLE>Arb-Help Index</TITLE></HEAD>' >$@ 
    203                 @echo '<BODY>' >>$@ 
    204                 @cat $< |  sed -e 's/^\(.*\)$$/<A href="\1">\1<\/A> /'  >>$@ 
    205                 @echo '</BODY></HTML>' >>$@ 
    206  
    207 # -------------------------------------------------------------------------------- 
    208  
    209 html : $(HTML) google_logo 
    210  
    211 html_index : $(HTML_IDX) 
    212  
    213 # -------------------------------------------------------------------------------- 
     205html : $(HTML) google_logo $(HTML_LOCATION)/$(HELP_INDEX_NAME).html 
    214206 
    215207help : $(HELP) 
    … …  
    218210 
    219211clean: 
    220                 rm -f $(TOOL_OBJECTS) $(BINARIES) 
    221                 rm -f $(HTML_IDX) `find $(HLP_DEST) -name "*.hlp"` 
    222                 rm -f html.list `find $(HTML_LOCATION) -name "*.html"` 
    223                 rm -f $(XML_DEPEND) dummy `find $(XML_LOCATION) -name "*.xml"` 
    224                 $(MAKE) -C $(HLP_GENERATED) clean 
     212        rm -f $(TOOL_OBJECTS) $(BINARIES) 
     213        rm -f `find $(HLP_DEST) -name "*.hlp"` 
     214        rm -f `find $(HTML_LOCATION) -name "*.html"` 
     215        rm -f $(XML_DEPEND) dummy `find $(XML_LOCATION) -name "*.xml"` 
     216        $(MAKE) -C $(HLP_GENERATED) clean 
    225217 
    226218# -------------------------------------------------------------------------------- 
    … …  
    265257arb_help2xml.o: $(ARBHOME)/INCLUDE/dupstr.h 
    266258arb_help2xml.o: $(ARBHOME)/INCLUDE/test_global.h 
     259arb_help2xml.o: $(ARBHOME)/INCLUDE/test_unit.h 
    267260arb_help2xml.o: $(ARBHOME)/INCLUDE/xml.hxx 

  • trunk/HELP_SOURCE/arb_help.dtd

    r5775 r7018  
    5353<!ATTLIST LINK source_line CDATA #IMPLIED > <!--line no in source file--> 
    5454<!ATTLIST LINK missing (0|1) #IMPLIED > <!--set to 1 if destination is missing (used for internal links only)--> 
     55<!ATTLIST LINK quoted (0|1) #IMPLIED > <!--set to 0 to avoid quoting of title--> 

  • trunk/HELP_SOURCE/arb_help2xml.cxx

    r7017 r7018  
    261261    Section       title; 
    262262    NamedSections sections; 
     263    string        inputfile; 
    263264 
    264265public: 
    … …  
    426427 
    427428void Helpfile::readHelp(istream& in, const string& filename) { 
    428     Reader      read(in); 
     429    Reader read(in); 
     430 
     431    inputfile = filename; // remember file read (for comment) 
     432 
    429433    const char *line; 
    430434    const char *name_only = strrchr(filename.c_str(), '/'); 
    … …  
    11731177 
    11741178    XML_Document xml("PAGE", "arb_help.dtd", out); 
     1179 
    11751180    xml.skip_empty_tags       = true; 
    11761181    xml.indentation_per_level = 2; 
    … …  
    11831188#endif // DEBUG 
    11841189 
     1190    { 
     1191        XML_Comment(string("automatically generated from ../")+inputfile+' '); 
     1192    } 
     1193 
    11851194    create_top_links(uplinks, "UP"); 
    11861195    create_top_links(references, "SUB"); 
    11871196    create_top_links(auto_references, "SUB"); 
    1188  
     1197     
    11891198    { 
    11901199        XML_Tag title_tag("TITLE"); 

  • trunk/HELP_SOURCE/oldhelp/islandhopping.hlp

    r2986 r7018  
    99 
    1010#************* Title of helpfile !! and start of real helpfile ******** 
    11 TITLE           'Island Hopper' 
     11TITLE           Island Hopper 
    1212 
    1313OCCURRENCE      ARB_EDIT4/Edit/Integrated Aligners 

  • trunk/HELP_SOURCE/oldhelp/primer.hlp

    r6141 r7018  
    1111TITLE           Primer Design 
    1212 
    13                 @@@ sorry - need translation into english  
    1413 
    1514 
    16 DESCRIPTION     nur markierte Sequencen 
     15DESCRIPTION 
     16                @@@ need translation into english  
     17 
     18                nur markierte Sequencen 
    1719                Daten muessen aligned sein, 
    1820                sucht alignmentabschnitte mit moeglichst wenig verschiedenen 

  • trunk/HELP_SOURCE/oldhelp/st_ml.hlp

    r6141 r7018  
    1010 
    1111TITLE           Column Statistic (Prototype) 
    12                 Detailed column statistic (see below) 
    1312 
    1413OCCURRENCE      ARB EDITOR 
    … …  
    3938                The program can only be started once. 
    4039 
    41 SECTION         DETAILED COLUMN STATISTIC 
     40SECTION         Detailed column statistic 
    4241 
    4342                This special mode displays 4 rows below the sequence containing 

  • trunk/HELP_SOURCE/to_html.xsl

    r6765 r7018  
    256256 
    257257  <xsl:template match="LINK" mode="link-recursion"> 
     258    <xsl:variable name="quoted"> 
     259      <xsl:choose> 
     260        <xsl:when test="@quoted='0'">0</xsl:when> 
     261        <xsl:otherwise>1</xsl:otherwise> 
     262      </xsl:choose> 
     263    </xsl:variable> 
    258264    <xsl:choose> 
    259265      <xsl:when test="@type='hlp' or @type='ps' or @type='pdf'"> 
    … …  
    262268          <xsl:with-param name="type" select="@type"/> 
    263269          <xsl:with-param name="missing" select="@missing"/> 
    264           <xsl:with-param name="quote" select="1"/> 
     270          <xsl:with-param name="quote" select="$quoted"/> 
    265271        </xsl:call-template> 
    266272      </xsl:when> 
    … …  
    396402            <TD valign="top" align="right"> 
    397403              <FONT size="-1"> 
    398                 More documentation can be found on the 
     404                <NOBR>More docs on the 
    399405                <xsl:call-template name="insert-link"> 
    400406                  <xsl:with-param name="linktext" select="'ARB website'"/> 
    401407                  <xsl:with-param name="address" select="'http://rtfm.arb-home.de/'"/> 
    402                 </xsl:call-template>.<BR/> 
     408                </xsl:call-template>.</NOBR><BR/> 
     409                See also <A href="{concat($rootpath,'aaa_help_index')}.html">index</A> of helppages.<BR/> 
    403410                Last update on <xsl:value-of select="$date"/>. 
    404411              </FONT> 

  • trunk/util/arb_srclst.pl

    r6884 r7018  
    5757                                      'ARB_GDEmenus', 
    5858                                      'makeloc.here', 
    59                                       'helpfiles.lst', 
    60                                       '_index.html', 
    6159                                      'nt_date.h', 
    6260                                      'TAGS',