]> granicus.if.org Git - python/commitdiff
Add support for the "Aesop Meta Tag". Not widely used, but not a bad idea,
authorFred Drake <fdrake@acm.org>
Fri, 5 Apr 2002 17:34:50 +0000 (17:34 +0000)
committerFred Drake <fdrake@acm.org>
Fri, 5 Apr 2002 17:34:50 +0000 (17:34 +0000)
either.

Doc/perl/l2hinit.perl
Doc/tools/mkackshtml
Doc/tools/mkmodindex
Doc/tools/support.py

index 0bc9aa59d23622e8a8b8306b516f5c54bd367747..b7ade490845135c2d5b0b0ad0811808059998972 100644 (file)
@@ -37,6 +37,8 @@ $HAVE_MODULE_INDEX = 0;
 $HAVE_GENERAL_INDEX = 0;
 $HAVE_TABLE_OF_CONTENTS = 0;
 
+$AESOP_META_TYPE = 'information';
+
 
 # A little painful, but lets us clean up the top level directory a little,
 # and not be tied to the current directory (as far as I can tell).  Testing
@@ -639,6 +641,8 @@ sub make_head_and_body {
          , "<html>\n<head>\n<title>", $title, "</title>\n"
          , &meta_information($title)
          , $MY_PARTIAL_HEADER
+         , ($AESOP_META_TYPE eq '' ? ''
+            : "\n<meta name='aesop' content='$AESOP_META_TYPE'>")
          , "\n</head>\n<body$body>");
 }
 
index 917b3035f2eeae2a3db6457b1698a15714b27f39..79fe3f92f51267b061cb8742d265bb1c7cfd9a0b 100755 (executable)
@@ -30,6 +30,7 @@ def main():
     colnums = []
     for i in range(options.columns):
         colnums.append(percol*i)
+    options.aesop_type = "information"
     fp = options.get_output_file()
     fp.write(string.rstrip(options.get_header()) + "\n")
     fp.write(THANKS + "\n")
index 23a200e7eb33af0025ed1b58636bbc34a482c422..58ba05e3dfe832284d2b43fb5c35070ddaf1a6a0 100755 (executable)
@@ -34,6 +34,8 @@ import sys
 
 
 class IndexOptions(support.Options):
+    aesop_type = "links"
+
     def __init__(self):
         support.Options.__init__(self)
         self.add_args("l", ["letters"])
index 187ac21a759b6703bbdde90c047611bd9bb05411..bc17c6eccc69d349ae4ff9073b7624d4ab1bdedd 100644 (file)
@@ -28,6 +28,24 @@ class Options:
     uplink = "index.html"
     uptitle = "Python Documentation Index"
 
+    # The "Aesop Meta Tag" is poorly described, and may only be used
+    # by the Aesop search engine (www.aesop.com), but doesn't hurt.
+    #
+    # There are a number of values this may take to roughly categorize
+    # a page.  A page should be marked according to its primary
+    # category.  Known values are:
+    #   'personal'    -- personal-info
+    #   'information' -- information
+    #   'interactive' -- interactive media
+    #   'multimedia'  -- multimedia presenetation (non-sales)
+    #   'sales'       -- sales material
+    #   'links'       -- links to other information pages
+    #
+    # Setting the aesop_type value to one of these strings will cause
+    # get_header() to add the appropriate <meta> tag to the <head>.
+    #
+    aesop_type = None
+
     def __init__(self):
         self.args = []
         self.variables = {"address": "",
@@ -96,6 +114,12 @@ class Options:
                 link = '<link rel="up" href="%s">' % self.uplink
             repl = "  %s\n</head>" % link
             s = s.replace("</head>", repl, 1)
+        if self.aesop_type:
+            meta = '\n  <meta name="aesop" content="%s">'
+            # Insert this in the middle of the head that's been
+            # generated so far, keeping <meta> and <link> elements in
+            # neat groups:
+            s = s.replace("<link ", meta + "<link ", 1)
         return s
 
     def get_footer(self):