Changeset 4557

Show
Ignore:
Timestamp:
05/04/08 08:29:00 (4 months ago)
Author:
mramm
Message:

Another doc update.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/docs/2.0/DownloadInstall.rst

    r4554 r4557  
    7878Then you have installed TurboGears 2. 
    7979 
    80  .. note:: if you have installed old dependency packages, you could remove them from:: 
    81  
    82  {python_path}/site-packages/easy_install.pth 
    83  
     80 .. note:: if you have installed old dependency packages, you could remove them from ``{python_path}/site-packages/easy_install.pth`` 
    8481 
    8582Validate the installation: 
    …… 
    104101 
    105102 . $ sudo easy_install -U -f http://toscawidgets.org/download/wo_speedups/ RuleDispatch 
     103  
    106104If you get the following error when starting a project with ``paster serve``:: 
    107105 
    108106 . AttributeError: 'WSGIRequest' object has no attribute 'accept_language' 
     107  
    109108update your Pylons checkout with ``hg update`` and try again. 
    110109 

  • trunk/docs/2.0/ToscaWidgets/Cookbook.rst

    r4396 r4557  
    1  
     1#format rst 
    22 
    33ToscaWidgets Cookbook 
    44===================== 
    5  
    6 Here you will find information about how to do common tasks involving ToscaWidgets. 
    7  
    8 Ajax Widgets 
    9 ------------ 
    10  
    11 Ajax Forms 
    12 ~~~~~~~~~~~~~~~~~~ 
    13  How to use ActiveForm to create a dynamic forms using JSON.  
    14  
    15  `(ActiveForm Tutorial) <./Cookbook/ActiveForm.html.html>`_ 
    16  
     5   
     6  Here you will find information about how to do common tasks involving ToscaWidgets. 
     7 
     8Javascript Library Specific Widgets 
     9----------------------------------------- 
     10 
     11ExtJS 
     12~~~~~~~~ 
     13 
     14TreeView 
     15````````` 
     16 Learn how to use the ext widget library to create a dynamically loading TreeView. 
     17 
     18 `(ExtTreeView Tutorial) </ExtTreeView>`_ 
     19 
     20 
     21 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/ExtItemSelector?action=AttachFile&do=get&target=itemselector1.png 
     22 
     23   :height: 140 
     24 
     25ItemSelector 
     26```````````` 
     27 How to use the ext ItemSelector which allows multiple selection by shuttling items between source and destination lists. It supports full drag and drop and ordering of items. 
     28 
     29 `(ItemSelector Tutorial) </ExtItemSelector>`_ 
     30 
     31 
     32 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/ExtSingleSelectCombo?action=AttachFile&do=get&target=singleselectcombo-small.png 
     33   :height: 120 
     34 
     35SingleSelectCombo 
     36````````````````` 
     37 Create a ComboBox using Ext which also does autocompletion. 
     38 
     39 `(SingleSelectCombo Tutorial) </ExtSingleSelectCombo>`_ 
     40 
     41jQuery 
     42~~~~~~~ 
    1743 
    1844 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/AutoComplete?action=AttachFile&do=get&target=autocomplete_small.png 
    …… 
    2147 
    2248AutoComplete Field 
    23 ~~~~~~~~~~~~~~~~~~ 
     49`````````````````` 
    2450 Create a field which automatically completes the user entry as they type.  Based on tw.jquery AutoComplete widget. 
    2551 
    2652 
    27  `(AutoComplete Tutorial) <./AutoComplete.html>`_ 
     53 `(AutoComplete Tutorial) </AutoComplete>`_ 
    2854 
    2955 
    …… 
    3359 
    3460FlexiGrid 
     61````````` 
     62 How to create an Ajax Data Grid with support for pagination, sorting, searching and column resizing. This widget is based on the jQuery FlexiGrid Plugin. 
     63 
     64 `(FlexiGrid Tutorial) </FlexiGrid>`_ 
     65 
     66Ajax Form 
     67```````````` 
     68 How to use AjaxForm to create a dynamic form.  
     69 
     70 `(jQueryAjaxForm Tutorial) </JQueryAjaxForm>`_ 
     71 
     72Flot 
     73```````````` 
     74 How to create dynamic graphs using the powerful Flot library. 
     75 
     76 `(Flot Tutorial) </Flot>`_ 
     77 
     78 
     79 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/TreeView?action=AttachFile&do=get&target=treeview.png 
     80   :align: right 
     81   :height: 120 
     82 
     83 
     84Tree View 
     85``````````` 
     86 How to create a simple tree view of an unordered list where the branches can be expanded or collapsed to present a good view of a document tree structure. This widget is based on the jQuery Treeview Plugin. 
     87 
     88`(TreeView Tutorial) </TreeView>`_ 
     89 
     90 
     91Ajax Graphs 
     92````````````` 
     93 How to add an ajax graph to your system using tw.jquery and flot. 
     94 
     95 `(FlotWidget Tutorial) </FlotWidget>`_ 
     96 
     97  
     98 .. image :: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Using?action=AttachFile&do=get&target=stars.png 
     99    :align: right 
     100 
     101Ajax Star Rating 
     102```````````````` 
     103 How to a simple star rating widget to your application. 
     104 
     105 `(StarRating Tutorial) <../Using>`_ 
     106 
     107Prototype 
    35108~~~~~~~~~ 
    36  How to create an Ajax Data Grid with support for pagination, sorting, searching and column resizing. This widget is based on the jQuery FlexiGrid Plugin. 
    37  
    38  `(FlexiGrid Tutorial) <./Cookbook/FlexiGrid.html>`_ 
    39  
    40 Ajax Graphs 
    41 ~~~~~~~~~~~~~~~~~~~ 
    42  How to add an ajax graph to your system using tw.jquery and flot. 
    43  
    44  `(FlotWidget Tutorial) <./Cookbook/FlotWidget.html>`_ 
    45  
    46 Ajax Star Rating 
    47 ~~~~~~~~~~~~~~~~ 
    48  How to a simple star rating widget to your application. 
    49  
    50  `(StarRating Tutorial) <../Using.html>`_ 
    51  
    52 Ajax Select Shuttle 
    53 ~~~~~~~~~~~~~~~~~~~ 
    54  How to create a select shuttle field in your code and make it work with ajax in the back end. 
    55  
    56  `(SelectShuttle Tutorial) <./Cookbook/AjaxSelectShuttle.html>`_ 
    57  
     109 
     110Ajax Form 
     111```````````` 
     112 How to use AjaxForm to create a dynamic form.  
     113 
     114 `(ActiveForm Tutorial) </ActiveForm>`_ 
     115 
     116 
     117Dojo 
     118~~~~~ 
     119 
     120Need some basic widgets here. 
     121 
     122JSUnit 
     123~~~~~~ 
     124 
     125 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/JSUnit?action=AttachFile&do=get&target=jsunit.png 
     126    :align: right 
     127    :height: 120 
     128    :alt: example JSUnit Widget 
     129 
     130JSUnit and Runner Widget 
     131```````````````````````` 
     132 Create a widget for in-browser testing of javascript code using the `JSUnit Javascript Unit Testing Framework <http://www.jsunit.net/>`_. 
     133 
     134 
     135 `(JSUnit Tutorial) </JSUnit>`_ 
     136 
     137 
     138To Be Done 
     139~~~~~~~~~~~~ 
    58140 
    59141Ajax Related Select Fields 
    60 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     142`````````````````````````````` 
    61143 How to create select fields which change based on the choices made on other select fields.  
    62144 
    63  `(Related SelectShuttle Tutorial) <./Cookbook/RelatedSelectShuttle.html>`_ 
     145 `(Related SelectShuttle Tutorial) </RelatedSelectShuttle>`_ 
    64146 
    65147Ajax Progress Bar 
    66 ~~~~~~~~~~~~~~~~~ 
     148````````````````` 
    67149  How to create a progress bar with server-side progress indicator 
    68150 
    69  `(ProgressBar Tutorial) <./Cookbook/ProgressBar.html>`_ 
     151 `(ProgressBar Tutorial) </ProgressBar>`_ 
    70152 
    71153Ajax File Upload with Progress Bar 
    72 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     154````````````````````````````````````` 
    73155  
    74156 How to create a file upload with a progress bar. 
    75157 
    76  `(FileProgressBar Tutorial) <./Cookbook/FileProgressBar.html>`_ 
     158 `(FileProgressBar Tutorial) </FileProgressBar>`_ 
    77159 
    78160tw.forms 
    79161-------- 
    80162 
     163Basic Form usage (no ajax) 
     164~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     165 
    81166 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/PasswordValidation?action=AttachFile&do=get&target=passwordverify.png 
    82167   :align: right 
    …… 
    84169 
    85170Password Validation 
    86 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     171```````````````````` 
    87172 How to create a simple registration form with that makes sure the user typed the correct password  
    88173 
    89  `(Password Validation Tutorial) <./Cookbook/PasswordValidation.html>`_ 
     174 `(Password Validation Tutorial) </PasswordValidation>`_ 
    90175 
    91176 .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/ReCaptcha?action=AttachFile&do=get&target=recaptcha_field.jpg 
    …… 
    94179 
    95180ReCaptcha 
    96 ~~~~~~~~~~ 
     181`````````` 
    97182 A Description on how to add a tw.recaptcha field to your public forms an keep spammers at bay. 
    98183 
    99  `(Recaptcha Tutorial) <./Cookbook/ReCaptcha.html>`_ 
     184 `(Recaptcha Tutorial) </ReCaptcha>`_ 
    100185 
    101186 
    …… 
    104189 How to create a select field which changes based on the entry in a database table.  
    105190  
    106  `(Dynamic Select Field Tutorial) <./Cookbook/DynamicSelect.html>`_ 
    107  
    108 Other Valuable Widgets 
    109 ---------------------- 
    110  
     191 `(Dynamic Select Field Tutorial) </DynamicSelect>`_ 
     192 
     193Other Valuable Widgets (no JS library) 
     194---------------------------------------- 
     195 
     196Css based 
     197~~~~~~~~~~ 
    111198Tabber 
    112 ~~~~~~~ 
     199`````````` 
    113200 
    114201 How to easily add Tabbed Browsing to your website. 
    115202  
    116  `(Tabber Tutorial) <./Cookbook/TabbedBrowsing.html>`_ 
    117  
    118  .. image:: http://docs.turbogears.org/2.0/RoughDocs/ToscaWidgets/Cookbook/TreeView?action=AttachFile&do=get&target=treeview.png 
    119    :align: right 
    120    :height: 120 
    121  
    122 Tree View 
    123 ~~~~~~~~~ 
    124  How to create a simple tree view of an unordered list where the branches can be expanded or collapsed to present a good view of a document tree structure. This widget is based on the jQuery Treeview Plugin. 
    125  
    126  `(TreeView Tutorial) <./Cookbook/TreeView.html>`_ 
     203 `(Tabber Tutorial) </TabbedBrowsing>`_ 

  • trunk/docs/2.0/ToscaWidgets/ToscaWidgets.rst

    r4396 r4557  
    88    
    99   Using 
    10    Forms 
     10   forms 
    1111   Creation 
    1212   ExistingLibraries 

  • trunk/docs/conf.py

    r4370 r4557  
    11# -*- coding: utf-8 -*- 
    22# 
    3 # TurboGears2 documentation build configuration file, created by 
    4 # sphinx-quickstart.py on Wed Mar 26 10:27:34 2008. 
     3# TG2 documentation build configuration file, created by 
     4# sphinx-quickstart on Sat May  3 11:00:38 2008. 
    55# 
    66# This file is execfile()d with the current directory set to its containing dir. 
    …… 
    1212# serve to show the default value. 
    1313 
    14 import sys 
    15 import os 
    16 execfile(os.path.join("../tg", "release.py")) 
     14import sys, os 
    1715 
    18 # If your extensions are in another directory, add it here. 
    19 #sys.path.append('some/directory') 
     16# If your extensions are in another directory, add it here. If the directory 
     17# is relative to the documentation root, use os.path.abspath to make it 
     18# absolute, like shown here. 
     19#sys.path.append(os.path.abspath('some/directory')) 
    2020 
    2121# General configuration 
    …… 
    2424# Add any Sphinx extension module names here, as strings. They can be extensions 
    2525# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    26 #extensions = [] 
     26extensions = ['sphinx.ext.autodoc'] 
    2727 
    2828# Add any paths that contain templates here, relative to this directory. 
    …… 
    3636 
    3737# General substitutions. 
    38 project = 'TurboGears' 
    39 copyright = '2008, TurboGears Doc Team' 
     38project = 'TG2' 
     39copyright = '2008, TurboGears DocTeam' 
    4040 
    4141# The default replacements for |version| and |release|, also used in various 
    …… 
    4343# 
    4444# The short X.Y version. 
    45 version = version 
     45version = '1.9.7' 
    4646# The full version, including alpha/beta/rc tags. 
    47 release = version 
     47release = '1.9.7' 
    4848 
    4949# There are two options for replacing |today|: either, you set today to some 
    …… 
    7777# must exist either in Sphinx' static/ path, or in one of the custom paths 
    7878# given in html_static_path. 
    79 html_style = 'default.css' 
     79html_style = 'tg.css' 
     80 
     81# The name for this set of Sphinx documents.  If None, it defaults to 
     82# "<project> v<release> documentation". 
     83#html_title = None 
     84 
     85# The name of an image file (within the static path) to place at the top of 
     86# the sidebar. 
     87html_logo = 'tg.png' 
    8088 
    8189# Add any paths that contain custom static files (such as style sheets) here, 
    …… 
    92100#html_use_smartypants = True 
    93101 
    94 # Content template for the index page. 
    95 #html_index = '' 
    96  
    97102# Custom sidebar templates, maps document names to template names. 
    98103#html_sidebars = {} 
    …… 
    108113#html_copy_source = True 
    109114 
     115# If true, an OpenSearch description file will be output, and all pages will 
     116# contain a <link> tag referring to it. 
     117#html_use_opensearch = False 
     118 
    110119# Output file base name for HTML help builder. 
    111 htmlhelp_basename = 'TurboGears2doc' 
     120htmlhelp_basename = 'TG2doc' 
    112121 
    113122 
    …… 
    123132# Grouping the document tree into LaTeX files. List of tuples 
    124133# (source start file, target name, title, author, document class [howto/manual]). 
    125 #latex_documents = [] 
     134latex_documents = [ 
     135  ('index', 'TG2.tex', 'TG2 Documentation', 'TurboGears DocTeam', 'manual'), 
     136] 
     137 
     138# The name of an image file (relative to this directory) to place at the top of 
     139# the title page. 
     140#latex_logo = None 
    126141 
    127142# Additional stuff for the LaTeX preamble. 

  • trunk/docs/index.rst

    r4410 r4557  
    1818   2.0/QuickStart 
    1919   2.0/BasicMoves 
     20   2.0/WhatsNew 
    2021 
    2122Tutorials 
    …… 
    8687   2.0/ToscaWidgets/Using 
    8788   2.0/SimpleWidgetForm 
    88    2.0/RoughDocs/StaticFile 
     89 
    8990 
    9091General TG tools 
    …… 
    107108   2.0/TGandPyAMF 
    108109   2.0/RoutesIntegration 
     110   2.0/StaticFile 
    109111 
    110112 
    …… 
    120122   2.0/License 
    121123   2.0/TGandPylons 
    122    2.0/RoughDocs/WhatsNew 
    123124 
    124125Indices and tables