Package ListClassesAndMethods


Classes

class  l_Section
class  sub_section

Functions

def usage
 print usage info
def makeSafe
 conversion of strings to LaTeX compliant
def makeList

Variables

string __copyright__
 Short auto-documentation for SLIMpy.
string __license__
dictionary OPTIONS
string TITLE = 'SLIMpy methods and classes'
dictionary HEADER
dictionary FOOTER
dictionary LINEEND = { 'LaTeX': '\n', 'HTML': '\n', 'TEXT': '\n' }
dictionary LINEBREAK = { 'LaTeX': '\n', 'HTML': '<BR>\n', 'TEXT': '\n' }
dictionary HLINE = { 'LaTeX': '\n', 'HTML': '<HR>\n', 'TEXT': '#'*30+'\n' }
dictionary SECTION = { 'LaTeX': ['\\section*{','}\n'], 'HTML': ['<H3>','</H3>\n'], 'TEXT': ['# ','\n\n'] }
dictionary SUBSECTION = { 'LaTeX': ['\\subsection*{','}\n'], 'HTML': ['<H4>','</H4>\n'], 'TEXT': ['### ','\n'] }
dictionary ITEMIZE = { 'LaTeX': ['\\begin{itemize}\n','\\end{itemize}\n'], 'HTML': ['<UL>\n','</UL>\n'], 'TEXT': ['\n','\n'] }
dictionary ITEM = { 'LaTeX': ['\\item ','\n'], 'HTML': ['<LI>','</LI>\n'], 'TEXT': [' || ','\n'] }
dictionary PARAGRAPH = { 'LaTeX': ['\n','\n'], 'HTML': ['<P>','</P>\n'], 'TEXT': ['','\n'] }
string FORMAT = 'TEXT'
list FileIn = args[0]
 Output = None
tuple pickle_file = open(FileIn)
tuple Document = pickle.load( pickle_file )


Function Documentation

def ListClassesAndMethods.makeList (   Document,
  Output,
  FORMAT 
)

Definition at line 150 of file ListClassesAndMethods.py.

def ListClassesAndMethods.makeSafe (   format,
  text 
)

conversion of strings to LaTeX compliant

Definition at line 81 of file ListClassesAndMethods.py.

def ListClassesAndMethods.usage (  ) 

print usage info

Definition at line 67 of file ListClassesAndMethods.py.


Variable Documentation

string __copyright__

Initial value:

"""
Copyright 2008 Henryk Modzelewski
"""
Short auto-documentation for SLIMpy.

Definition at line 7 of file ListClassesAndMethods.py.

string __license__

Initial value:

"""
This file is part of SLIMpy .

SLIMpy is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SLIMpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
"""

Definition at line 10 of file ListClassesAndMethods.py.

tuple Document = pickle.load( pickle_file )

Definition at line 349 of file ListClassesAndMethods.py.

list FileIn = args[0]

Definition at line 339 of file ListClassesAndMethods.py.

dictionary FOOTER

Initial value:

{
    'LaTeX': '''\n''',
    'HTML': '''<P><I>'''+time.asctime()+'''</I></BODY>\n''',
    'TEXT': '''\n'''+time.asctime()+'''\n'''
}

Definition at line 51 of file ListClassesAndMethods.py.

string FORMAT = 'TEXT'

Definition at line 320 of file ListClassesAndMethods.py.

dictionary HEADER

Initial value:

{
    'LaTeX': '''\\maketitle''',
    'HTML': '''<HTML><HEAD><TITLE>'''+TITLE+'''</TITLE></HEAD><BODY>\n''',
    'TEXT': '''\n'''
}

Definition at line 46 of file ListClassesAndMethods.py.

dictionary HLINE = { 'LaTeX': '\n', 'HTML': '<HR>\n', 'TEXT': '#'*30+'\n' }

Definition at line 58 of file ListClassesAndMethods.py.

dictionary ITEM = { 'LaTeX': ['\\item ','\n'], 'HTML': ['<LI>','</LI>\n'], 'TEXT': [' || ','\n'] }

Definition at line 62 of file ListClassesAndMethods.py.

dictionary ITEMIZE = { 'LaTeX': ['\\begin{itemize}\n','\\end{itemize}\n'], 'HTML': ['<UL>\n','</UL>\n'], 'TEXT': ['\n','\n'] }

Definition at line 61 of file ListClassesAndMethods.py.

dictionary LINEBREAK = { 'LaTeX': '\n', 'HTML': '<BR>\n', 'TEXT': '\n' }

Definition at line 57 of file ListClassesAndMethods.py.

dictionary LINEEND = { 'LaTeX': '\n', 'HTML': '\n', 'TEXT': '\n' }

Definition at line 56 of file ListClassesAndMethods.py.

dictionary OPTIONS

Initial value:

{
'text':'generate quick and dirty text output (default)',
'html':'generate HTML output to directory (dir-out must be specified)',
'latex':'generate LaTeX output to file',
'help':'this info'
}

Definition at line 30 of file ListClassesAndMethods.py.

list Output = None

Definition at line 340 of file ListClassesAndMethods.py.

dictionary PARAGRAPH = { 'LaTeX': ['\n','\n'], 'HTML': ['<P>','</P>\n'], 'TEXT': ['','\n'] }

Definition at line 63 of file ListClassesAndMethods.py.

tuple pickle_file = open(FileIn)

Definition at line 348 of file ListClassesAndMethods.py.

dictionary SECTION = { 'LaTeX': ['\\section*{','}\n'], 'HTML': ['<H3>','</H3>\n'], 'TEXT': ['# ','\n\n'] }

Definition at line 59 of file ListClassesAndMethods.py.

dictionary SUBSECTION = { 'LaTeX': ['\\subsection*{','}\n'], 'HTML': ['<H4>','</H4>\n'], 'TEXT': ['### ','\n'] }

Definition at line 60 of file ListClassesAndMethods.py.

string TITLE = 'SLIMpy methods and classes'

Definition at line 45 of file ListClassesAndMethods.py.


Generated on Sun Aug 10 09:11:08 2008 for SLIMpy by  doxygen 1.5.6