docs/README.txt
branchZTK-1.1
changeset 148 d3668ecd9137
parent 45 6b70bf7c698f
equal deleted inserted replaced
147:044dc196ec8a 148:d3668ecd9137
       
     1 ==================
       
     2 ztfy.utils package
       
     3 ==================
       
     4 
       
     5 .. contents::
       
     6 
       
     7 What is ztfy.utils ?
       
     8 ====================
       
     9 
       
    10 ztfy.utils is a set of classes and functions which can be used to handle many small operations.
       
    11 
       
    12 Internal sub-packages include :
       
    13  - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime
       
    14  - request : get current request, get request annotations, get and set request data via annotations
       
    15  - security : get unproxied value of a given object ; can be applied to lists or dicts
       
    16  - timezone : convert datetime to a given timezone ; provides a server default timezone utility
       
    17  - traversing : get object parents until a given interface is implemented
       
    18  - unicode : convert any text to unicode for easy storage
       
    19  - protocol : utility functions and modules for several nerwork protocols
       
    20  - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item
       
    21  - text : simple text operations and text to HTML conversion
       
    22  - html : HTML parser and HTML to text converter
       
    23  - file : file upload data converter
       
    24  - tal : text and HTML conversions for use from within TAL
       
    25 
       
    26 
       
    27 How to use ztfy.utils ?
       
    28 =======================
       
    29 
       
    30 A set of ztfy.utils usage are given as doctests in ztfy/utils/doctests/README.txt