""" HeaderID Extension for Python-Markdown ====================================== Auto-generate id attributes for HTML headers. See <https://pythonhosted.org/Markdown/extensions/header_id.html> for documentation. Original code Copyright 2007-2011 [Waylan Limberg](http://achinghead.com/). All changes Copyright 2011-2014 The Python Markdown Project License: [BSD](http://www.opensource.org/licenses/bsd-license.php) """ from __future__ import absolute_import from __future__ import unicode_literals from . import Extension from ..treeprocessors import Treeprocessor from ..util import parseBoolValue from .toc import slugify, unique, stashedHTML2text import warnings class HeaderIdTreeprocessor(Treeprocessor): """ Assign IDs to headers. """ IDs = set() def run(self, doc): start_level, force_id = self._get_meta() slugify = self.config['slugify'] sep = self.config['separator'] for elem in doc: if elem.tag in ['h1', 'h2', 'h3', 'h4', 'h5', 'h6']: if force_id: if "id" in elem.attrib: id = elem.get('id') else: id = stashedHTML2text(''.join(elem.itertext()), self.md) id = slugify(id, sep) elem.set('id', unique(id, self.IDs)) if start_level: level = int(elem.tag[-1]) + start_level if level > 6: level = 6 elem.tag = 'h%d' % level def _get_meta(self): """ Return meta data suported by this ext as a tuple """ level = int(self.config['level']) - 1 force = parseBoolValue(self.config['forceid']) if hasattr(self.md, 'Meta'): if 'header_level' in self.md.Meta: level = int(self.md.Meta['header_level'][0]) - 1 if 'header_forceid' in self.md.Meta: force = parseBoolValue(self.md.Meta['header_forceid'][0]) return level, force class HeaderIdExtension(Extension): def __init__(self, *args, **kwargs): # set defaults self.config = { 'level': ['1', 'Base level for headers.'], 'forceid': ['True', 'Force all headers to have an id.'], 'separator': ['-', 'Word separator.'], 'slugify': [slugify, 'Callable to generate anchors'] } super(HeaderIdExtension, self).__init__(*args, **kwargs) warnings.warn( 'The HeaderId Extension is pending deprecation. Use the TOC Extension instead.', PendingDeprecationWarning ) def extendMarkdown(self, md, md_globals): md.registerExtension(self) self.processor = HeaderIdTreeprocessor() self.processor.md = md self.processor.config = self.getConfigs() if 'attr_list' in md.treeprocessors.keys(): # insert after attr_list treeprocessor md.treeprocessors.add('headerid', self.processor, '>attr_list') else: # insert after 'prettify' treeprocessor. md.treeprocessors.add('headerid', self.processor, '>prettify') def reset(self): self.processor.IDs = set() def makeExtension(*args, **kwargs): return HeaderIdExtension(*args, **kwargs)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__init__.py | File | 3.76 KB | 0644 |
|
__init__.pyc | File | 4 KB | 0644 |
|
abbr.py | File | 2.67 KB | 0644 |
|
abbr.pyc | File | 4.14 KB | 0644 |
|
admonition.py | File | 3.09 KB | 0644 |
|
admonition.pyc | File | 3.66 KB | 0644 |
|
attr_list.py | File | 6.12 KB | 0644 |
|
attr_list.pyc | File | 6.21 KB | 0644 |
|
codehilite.py | File | 9.54 KB | 0644 |
|
codehilite.pyc | File | 9.3 KB | 0644 |
|
def_list.py | File | 3.66 KB | 0644 |
|
def_list.pyc | File | 4.31 KB | 0644 |
|
extra.py | File | 5.42 KB | 0644 |
|
extra.pyc | File | 5.57 KB | 0644 |
|
fenced_code.py | File | 4.01 KB | 0644 |
|
fenced_code.pyc | File | 4.45 KB | 0644 |
|
footnotes.py | File | 14.57 KB | 0644 |
|
footnotes.pyc | File | 14.79 KB | 0644 |
|
headerid.py | File | 3.24 KB | 0644 |
|
headerid.pyc | File | 4.23 KB | 0644 |
|
meta.py | File | 2.34 KB | 0644 |
|
meta.pyc | File | 2.95 KB | 0644 |
|
nl2br.py | File | 859 B | 0644 |
|
nl2br.pyc | File | 1.54 KB | 0644 |
|
sane_lists.py | File | 1.56 KB | 0644 |
|
sane_lists.pyc | File | 2.73 KB | 0644 |
|
smart_strong.py | File | 1.17 KB | 0644 |
|
smart_strong.pyc | File | 1.81 KB | 0644 |
|
smarty.py | File | 10.12 KB | 0644 |
|
smarty.pyc | File | 10.23 KB | 0644 |
|
tables.py | File | 7.67 KB | 0644 |
|
tables.pyc | File | 6.79 KB | 0644 |
|
toc.py | File | 10.79 KB | 0644 |
|
toc.pyc | File | 10.53 KB | 0644 |
|
wikilinks.py | File | 2.8 KB | 0644 |
|
wikilinks.pyc | File | 4.02 KB | 0644 |
|