Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

Commit [r7288] Maximize Restore History

Adapted 1.0 doc links to the new location of the index.

cito 2011-04-22

1 2 > >> (Page 1 of 2)
added /docs/1.0/TurboCheetah.rst
added /docs/1.0/TurboKid.rst
added /docs/1.0/ForeignKeysInFastData.rst
removed /docs/1.0/SitesUsingTurboGears.rst
changed /docs/1.0/FAQ.rst
changed /docs/1.0/index.rst
changed /docs/1.1/index.rst
changed /docs/1.5/index.rst
changed /docs/1.0/InstallTroubleshooting.rst
changed /docs/1.0/WidgetList.rst
changed /docs/1.0/SQLObjectQuickRef.rst
changed /docs/1.0/InstallMac.rst
changed /docs/1.0/SpecificProblems.rst
changed /docs/1.0/QuickStart.rst
changed /docs/1.0/GettingStarted/Arguments.rst
changed /docs/1.0/WidgetRecipes.rst
changed /docs/1.0/GettingStarted/MochiKit.rst
changed /docs/1.0/SqlObjectGotchas.rst
changed /docs/1.0/GettingStarted/Kid.rst
changed /docs/1.0/InstallBeta.rst
changed /docs/1.0/Wiki20/Page1.rst
changed /docs/1.0/Wiki20/Page2.rst
changed /docs/1.0/Install.rst
copied /docs/1.0/DocGen.rst -> /docs/1.0/FastData.rst
/docs/1.0/TurboCheetah.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/TurboKid.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/ForeignKeysInFastData.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/FAQ.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/index.rst Diff Switch to side-by-side view
Loading...
/docs/1.1/index.rst Diff Switch to side-by-side view
Loading...
/docs/1.5/index.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/InstallTroubleshooting.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/WidgetList.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/SQLObjectQuickRef.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/InstallMac.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/SpecificProblems.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/QuickStart.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/GettingStarted/Arguments.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/WidgetRecipes.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/GettingStarted/MochiKit.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/SqlObjectGotchas.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/GettingStarted/Kid.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/InstallBeta.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/Wiki20/Page1.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/Wiki20/Page2.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/Install.rst Diff Switch to side-by-side view
Loading...
/docs/1.0/DocGen.rst to /docs/1.0/FastData.rst
--- a/docs/1.0/DocGen.rst
+++ b/docs/1.0/FastData.rst
@@ -1,87 +1,91 @@
-docgen: How to make docs for TurboGears.org
-===========================================
+FastData
+========
 
-:Status: Official
-
-.. note:: The process described in this document refers to the creation of static
-    documents for the official `TurboGears web site`_. If you want to contribute to
-    the :doc:`TurboGears documentation </1.0>`, please read the :doc:`guidelines for contributing
-    documentation </DocHelp>`.
+:status: Official
 
 .. contents::
-  :depth: 2
+    :depth: 2
 
 
-There was a spot for "unofficial" docs in the `Documentation Playground`_ on the
-TurboGears Trac. All useful documents from the Trac wiki have bee migrated to this
-`MoinMoin wiki`_ at ``docs.turbogears.org``.  The Documentation Playground is now
-read-only. All new documentation should go into the docs wiki.
+.. _pypi page:
 
-.. _turbogears documentation: /1.0
-.. _documentation playground: http://trac.turbogears.org/wiki/DocumentationPlayground
-.. _moinmoin wiki: http://docs.turbogears.org/
-.. _turbogears web site: http://www.turbogears.org/
+Author:
+    Kevin Dangoor
+Maintainer:
+    TurboGears project
+Release information and download URL:
+    http://pypi.python.org/pypi/TGFastData
+SVN repository:
+    http://svn.turbogears.org/projects/FastData
 
 
-Building static HTML with docgen.py
------------------------------------
+Overview
+--------
 
-The ``turbogears.docgen`` module is responsible for generating the static
-portions of the `TurboGears web site`_.
+FastData is a TurboGears extension, designed to make fast proto-typing of
+administrative interfaces for your data easy by providing a CRUD interface to
+Create, Retrieve, Update and Delete instances of your
+:doc:`SQLObject <SQLObjectOverview>` :doc:`data model <GettingStarted/DefineDatabase>`
+objects.
 
-TurboGears docs are authored in XHTML, because it's a language that everyone understands and it translates quite well to the web. By using XHTML, we're able to conveniently do things like syntax highlighting using JavaScript.
+Fast Data has two main components:
 
-The docs are Kid templates which have site-wide styling applied via ``py:match`` rules. Generally speaking, there's not much else that's special about it. The main trick is that if you're writing about Kid, you'll need to **use two $ symbols whenever you want to show off ${}** variable interpolation.
-
-The basic boilerplate for a new document file is in **newdocs/newfile.html**. That extends the main content template for the site.
-
-Other kinds of files (images, CSS files, JavaScript files) will all get copied as-is over to the final site. When building the site, docgen makes a mirror of the original directory. So, if you delete a file, that file will get deleted from the site with no additional work required.
+* `FastDataGrid`_ -- a :doc:`TurboGears widget <Widgets>`  for a grid-like display for your data
+  items with action links for adding, changing and deleting items.
+* :doc:`DataController <DataController>` -- a controller class taking an SQLObject class and building
+  the methods for the CRUD interface.
 
 
-Printable docs
---------------
+Usage
+-----
 
-docgen has a crude ability to make versions of documents that are "printable". The printable documents have a different template applied which removes all of the navigation elements from the page. This same effect could likely be achieved via CSS. However, something else that is done by docgen's printable feature is to combine multiple documentation files into one. The "20 Minute Wiki" tutorial was what these feature was created for originally. The tutorial was broken into 6 pages, but the desired printable form was just a single page. Since the TG docs are XHTML, using standard XML techniques it was possible to combine the files into a single file and apply the printable template to get nicer output.
+.. toctree::
+   :hidden:
 
-The printable document generator does not get applied to every doc. This is where CSS would be a nicer solution. Also, the printable generator doesn't check to see if the original files had changed at all: it just always generates. Finally, it's not really written in a convenient, generic way to easily apply it to additional files.
+   ForeignKeysInFastData
+
+Documentation about using or including information on FastData can be found on
+the following wiki pages:
+
+* :doc:`DataController <DataController>`
+* :doc:`DataGrid <DataGridWidget>` (see section :ref:`fastdata_integration`)
+* :doc:`Foreign Keys In FastData <ForeignKeysInFastData>`
 
 
-Building the site on your machine
----------------------------------
+Installation
+------------
 
-If you'd like to see how the final, rendered docs would look, you can easily do so by running this command:
+FastData is an extension package for TurboGears and therefore needs to be
+installed separately. Installable egg files are provided on FastData's `PyPI
+page`_, so to download and install FastData, run the following from the command
+line::
 
-::
+    [sudo] easy_install TGFastData
 
-  python setup.py localsite
+If you are installing FastData into the system-wide location for Python packages
+(the default with the command above), you will need to obtain root priviledges
+by prefixing this command with ``sudo``.
 
 
-This will create a copy of the site in dist/docs. Note: the large video files and the download eggs are not included in that version of the site. Those are copied in separately when building the real site.
+Compatibility
+~~~~~~~~~~~~~
 
-----
+FastData is limited in that it only support :doc:`SQLObject <SQLObjectOverview>`
+data models. Support for creating forms for working with :doc:`SQLAlchemy <SQLAlchemy>`
+model objects is provided by the dbsprockets_ package, which builds on the
+ToscaWidgets_ project. dbsprockets can be used with TurboGears 2 as well as with
+TurboGears 1.x but at the moment only supports SQLAlchemy and requires that you
+install ToscaWidgets as well.
 
+.. _turbogears widget: Widgets
+.. _data model: GettingStarted/DefineDatabase
+.. _datacontroller: DataController
+.. _fastdata integration: DataGridWidget#fastdata-integration
 
-**Past comments:**
-
-.. parsed-literal::
-
-    **Adam Jones**
-    *2006-11-01 21:48:54*
-
-    Is this still relevant info given the port to moinmoin? Could this be
-    adapted into a documentation build system for user-made TG apps?
-
-    **kguertin**
-    *2006-11-13 20:23:21*
-
-    This document is only semi-accurate these days. It could certainly be used
-    to make documents from kid templates for other things but it is NOT used
-    for the moinmoin docs, obviously.
-
-    **ChristopherArndt**
-    *2007-06-11 07:05:38*
-
-    This document only refers to the building static HTML files for
-    www.turbogears.org not to documentation in the wiki. There is a note at the
-    top now, to make this clear. The process itself decribed here is still
-    valid.+.. _fastdatagrid:
+.. _datagrid: DataGridWidget
+.. _foreign keys in fastdata: ForeignKeysInFastData
+.. _sqlobject: SQLObject
+.. _sqlalchemy: SQLAlchemy
+.. _dbsprockets: http://code.google.com/p/dbsprockets/
+.. _toscawidgets: http://toscawidgets.org/
1 2 > >> (Page 1 of 2)