Add support for the "Aesop Meta Tag". Not widely used, but not a bad idea,

either.

Add support for the "Aesop Meta Tag". Not widely used, but not a bad idea,
either.
ca895afd · Fred Drake · 802a7d31 · ca895afd · ca895afd · ca895afd
Commit ca895afd authored Apr 05, 2002 by Fred Drake
Showing with 31 additions and 0 deletions

Doc/perl/l2hinit.perl Doc/perl/l2hinit.perl +4 -0

Doc/tools/mkackshtml Doc/tools/mkackshtml +1 -0

Doc/tools/mkmodindex Doc/tools/mkmodindex +2 -0

Doc/tools/support.py Doc/tools/support.py +24 -0

No files found.
--- a/Doc/perl/l2hinit.perl
+++ b/Doc/perl/l2hinit.perl
@@ -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>");
 }


--- a/Doc/tools/mkackshtml
+++ b/Doc/tools/mkackshtml
@@ -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")

--- a/Doc/tools/mkmodindex
+++ b/Doc/tools/mkmodindex
@@ -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"])

--- a/Doc/tools/support.py
+++ b/Doc/tools/support.py
@@ -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):