Extensions Docs Server: api_index.html, experimental.html

chrome/common/extensions/docs/server2/intro_data_source.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import re
 from path_utils import FormatKey
 from third_party.handlebar import Handlebar
 
 class IntroDataSource(object):
   """This class fetches the intros for a given API. From this intro, a table
   of contents dictionary is created, which contains the headings in the intro.
   """
   def __init__(self, cache_builder, base_paths):
     self._cache = cache_builder.build(self._MakeIntroDict)
     self._base_paths = base_paths
 
   def _MakeIntroDict(self, intro):
     h1s = re.findall('<h1.*>(.+)</h1>', intro)
     if len(h1s) > 0:
       page_title = h1s[0]
+      intro = re.sub('<h1.*>(.+)</h1>', '', intro, 1)

[cduvall, 2012/07/20 21:51:29]

Remove the h1 from the file because it is put in later in standard_article.html.

[not at google - send to devlin, 2012/07/23 12:40:24]

If it's here anyway why remove it?

If we do for some reason, can we arrange it so that we don't? We should avoid
changing the document if possible.

[cduvall, 2012/07/23 20:38:19]

I did this so in the template, the title could go above the TOC. I'll take this
out and you can look at the page and see if you're alright with where the TOC
is.

[not at google - send to devlin, 2012/07/23 23:37:43]

Ah I see. Is it not enough for the TOC to go over on the side like it does in
the API docs?

     else:
       page_title = ''
     headings = re.findall('<h([23]) id\="(.+)">(.+)</h[23]>', intro)
     toc = []
     for heading in headings:
       level, link, title = heading
       if level == '2':
         toc.append({ 'link': link, 'title': title, 'subheadings': [] })
       else:
         toc[-1]['subheadings'].append({ 'link': link, 'title': title })
     return { 'intro': Handlebar(intro), 'toc': toc , 'title': page_title }
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     real_path = FormatKey(key)
     for base_path in self._base_paths:
       try:
         return self._cache.GetFromFile(base_path + '/' + real_path)
       except Exception:
         pass
     return None