File: HTMLgen-DefinitionList.html

package info (click to toggle)
htmlgen 2.2.2-12.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,840 kB
  • ctags: 1,480
  • sloc: python: 4,518; makefile: 93
file content (149 lines) | stat: -rw-r--r-- 4,680 bytes parent folder | download | duplicates (7)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>

<!-- This file generated using Python HTMLgen module. -->
<HEAD>
  <META NAME="GENERATOR" CONTENT="HTMLgen 2.2.2">
        <TITLE>Class DefinitionList - Show a series of items and item definitions.</TITLE>

 <LINK rel=stylesheet href="HTMLgen.css" type=text/css title="HTMLgen.css">
</HEAD>
<BODY BGCOLOR="#FFFFFF" BACKGROUND="../image/bg-dots.gif" TEXT="#000000" LINK="#EE0000" VLINK="#990000">
<A HREF="HTMLgen-Define.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A> 
<A HREF="HTMLgen-Div.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<H3>Class DefinitionList - Show a series of items and item definitions.</H3>
<HR>

<H2>SYNOPSIS</H2>

<PRE>import HTMLgen</PRE>

<PRE>class DefinitionList(List)
  string __module__ = 'HTMLgen'
  tuple attrs = ('class', 'id', 'style')
  tuple flags = ('compact',)
  <A HREF="#def render_list_item(self, item)">def render_list_item(self, item)</A>
  string tagname = 'DL'

  # Methods inherited by DefinitionList from List
  def __getslice__(self, i, j)
  def __init__(self, list = None, **kw)
  def __str__(self)
  <A HREF="#def append(self, *items)">def append(self, *items)</A>
  <A HREF="#def column_slices(self, columns=1)">def column_slices(self, columns=1)</A>
  <A HREF="#def end_element(self)">def end_element(self)</A>
  <A HREF="#def multi_column_table(self)">def multi_column_table(self)</A>
  <A HREF="#def start_element(self)">def start_element(self)</A>
  <A HREF="#def sub_list(self, list)">def sub_list(self, list)</A>

  # Methods inherited by DefinitionList from UserList
  def __add__(self, list)
  def __cmp__(self, list)
  def __delitem__(self, i)
  def __delslice__(self, i, j)
  def __getitem__(self, i)
  def __len__(self)
  def __mul__(self, n)
  def __mul__(self, n)
  def __radd__(self, list)
  def __repr__(self)
  def __setitem__(self, i, item)
  def __setslice__(self, i, j, list)
  def count(self, item)
  def index(self, item)
  def insert(self, i, item)
  def pop(self, i=-1)
  def remove(self, item)
  def reverse(self)
  def sort(self, *args)
</PRE>

<PRE>alias DL = DefinitionList
</PRE>

<H2>DESCRIPTION</H2>


<P>Arg is a list of tuple pairs:
"(string/object,string/object),(,)..."  1st item in each pair is
the word to be defined. It will be rendered in bold. 2nd is the
string which will be indented to it's next-line-right. If the
<EM>compact</EM> flag is set to non-empty, the definition side will be
placed on the same line.  Example</P>


<P>    DefinitionList([( 4 , 'Number after 3') , ( 1 , 'Unity')] ) will emit:
    4
        Number after 3
    1
        Unity
</P>

<H3><A NAME="def append(self, *items)">def append(self, *items)</A></H3>


<P>Append entries to the end of the list
</P>

<H3><A NAME="def column_slices(self, columns=1)">def column_slices(self, columns=1)</A></H3>


<P>Calculate a list of index pairs bounding column slices.
</P>

<H3><A NAME="def end_element(self)">def end_element(self)</A></H3>


<P>Closes the HTML element
</P>

<H3><A NAME="def multi_column_table(self)">def multi_column_table(self)</A></H3>


<P>Return a table containing the list sliced into columns.
</P>

<H3><A NAME="def render_list_item(self, item)">def render_list_item(self, item)</A></H3>


<P>Overload method to perform DT/DD markup.
</P>

<H3><A NAME="def start_element(self)">def start_element(self)</A></H3>


<P>Generic creator for the HTML element opening tag.</P>


<P>Reads tagname, attrs and flags to return appropriate tag.
</P>

<H3><A NAME="def sub_list(self, list)">def sub_list(self, list)</A></H3>


<P>Recursive method for generating a subordinate list
</P>

<H2>SEE ALSO</H2>


<P><A HREF="HTMLgen_overview.html">HTMLgen</A></P>


<P><A HREF="HTMLgen-List.html">List</A></P>


<P><HR>
<A HREF="HTMLgen-Define.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A> 
<A HREF="HTMLgen-Div.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif"> 
<BR><IMG src="../image/Buzz.gif" height="51" width="56" alt="Buzz.gif" align="bottom">
<FONT SIZE="-1"><P>Copyright &#169 Robin Friedrich<BR>All Rights Reserved<BR>

Comments to author: <A HREF="mailto:&#102;rie&#100;ric&#104;@py&#116;hon&#112;ros&#46;com">friedrich@pythonpros.com</A><br>
Generated: Tue Apr 20, 1999 <BR><hr>
</FONT>
</BODY> </HTML>