python-markdown-doc 2.6.6-1 / usr / share / doc / python-markdown-doc / docs / extensions / attr_list.html

This file is indexed.

/usr/share/doc/python-markdown-doc/docs/extensions/attr_list.html is in python-markdown-doc 2.6.6-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<!DOCTYPE html>
<html>
<head>
<meta charset=utf-8>
<title>Attribute Lists Extension &#8212; Python Markdown</title>
<link rel="stylesheet" href="../default.css" type="text/css">
</head>
<body>

<div class="related">
  <h3>Navigation</h3>
  <ul>
    <li class="right" style="margin-right: 10px">
      <a href="../siteindex.html" title="General Index">index</a></li>
    <li class="right">
      <a href="definition_lists.html" title="Definition Lists Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="abbreviations.html" title="Abbreviations Extension"
         accesskey="P">previous</a> |</li>
    <li><img src="../py.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="../index.html">Python Markdown v2.6.6 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="attr_list.html">Attribute Lists Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="document">
  <div class="documentwrapper">
    <div class="bodywrapper">
      <div class="body">
<h1 id="attribute-lists">Attribute Lists<a class="headerlink" href="#attribute-lists" title="Permanent link">&para;</a></h1>
<h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">&para;</a></h2>
<p>The Attribute Lists extension adds a syntax to define attributes on the various
HTML elements in markdown&rsquo;s output.</p>
<p>This extension is included in the standard Markdown library.</p>
<h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">&para;</a></h2>
<p>The basic syntax was inspired by <a href="http://maruku.rubyforge.org/proposal.html#attribute_lists">Maruku</a>&lsquo;s Attribute Lists feature.</p>
<h3 id="the-list">The List<a class="headerlink" href="#the-list" title="Permanent link">&para;</a></h3>
<p>An example attribute list might look like this:</p>
<pre><code>{: #someid .someclass somekey='some value' }
</code></pre>
<p>A word which starts with a hash (<code>#</code>) will set the id of an element.</p>
<p>A word which starts with a dot (<code>.</code>) will be added to the list of classes 
assigned to an element.</p>
<p>A key/value pair (<code>somekey='some value'</code>) will assign that pair to the element.</p>
<p>Be aware that while the dot syntax will add to a class, using key/value pairs
will always override the previously defined attribute. Consider the following:</p>
<pre><code>{: #id1 .class1 id=id2 class="class2 class3" .class4 }
</code></pre>
<p>The above example would result in the following attributes being defined:</p>
<pre><code>id="id2" class="class2 class3 class4"
</code></pre>
<h3 id="block-level">Block Level<a class="headerlink" href="#block-level" title="Permanent link">&para;</a></h3>
<p>To define attributes for a block level element, the attribute list should
be defined on the last line of the block by itself.</p>
<pre><code>This is a paragraph.
{: #an_id .a_class }
</code></pre>
<p>The above results in the following output:</p>
<pre><code>&lt;p id="an_id" class="a_class"&gt;This is a paragraph.&lt;/p&gt;
</code></pre>
<p>The one exception is headers, as they are only ever allowed on one line.</p>
<pre><code>A setext style header {: #setext}
=================================

### A hash style header ### {: #hash }
</code></pre>
<p>The above results in the following output:</p>
<pre><code>&lt;h1 id="setext"&gt;A setext style header&lt;/h1&gt;
&lt;h3 id="hash"&gt;A hash style header&lt;/h3&gt;
</code></pre>
<h3 id="inline">Inline<a class="headerlink" href="#inline" title="Permanent link">&para;</a></h3>
<p>To define attributes on inline elements, the attribute list should be defined 
immediately after the inline element with no white space.</p>
<pre><code>[link](http://example.com){: class="foo bar" title="Some title!" }
</code></pre>
<p>The above results in the following output:</p>
<pre><code>&lt;p&gt;&lt;a href="http://example.com" class="foo bar" title="Some title!"&gt;link&lt;/a&gt;&lt;/p&gt;
</code></pre>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<p>See <a href="index.html">Extensions</a> for general extension usage, specify <code>markdown.extensions.attr_list</code>
as the name of the extension.</p>
<p>This extension does not accept any special configuration options.</p>
      </div> <!-- .body -->
    </div> <!-- .bodywrapper -->
  </div> <!-- .documentwrapper -->

  <div class="sphinxsidebar">
    <div class="sphinxsidebarwrapper">
    <h3>Table Of Contents</h3>
    <div class="toc">
<ul>
<li><a href="#attribute-lists">Attribute Lists</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#syntax">Syntax</a><ul>
<li><a href="#the-list">The List</a></li>
<li><a href="#block-level">Block Level</a></li>
<li><a href="#inline">Inline</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
</ul>
</li>
</ul>
</div>


    <h4>Previous topic</h4>
      <p class="topless"><a href="abbreviations.html"
         title="previous chapter">Abbreviations Extension</a></p>
    <h4>Next topic</h4>
      <p class="topless"><a href="definition_lists.html"
         title="next chapter">Definition Lists Extension</a></p>
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="https://github.com/waylan/Python-Markdown/issues"
             >Report a Bug</a></li>
      <li><a href="attr_list.txt"
             rel="nofollow">Show Source</a></li>
    </ul>
    </div> <!-- .sphinxsidebarwrapper -->
  </div> <!-- .sphinxsidebar -->

  <div class="clearer"></div>
</div> <!-- .document -->

<div class="related">
  <h3>Navigation</h3>
  <ul>
    <li class="right" style="margin-right: 10px">
      <a href="../siteindex.html" title="General Index">index</a></li>
    <li class="right">
      <a href="definition_lists.html" title="Definition Lists Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="abbreviations.html" title="Abbreviations Extension"
         accesskey="P">previous</a> |</li>
    <li><img src="../py.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="../index.html">Python Markdown v2.6.6 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="attr_list.html">Attribute Lists Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="footer">&copy; 2010-2012 Python Markdown Project</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.