Author: ianb Date: 2009-04-17 14:48:21 -0600 (Fri, 17 Apr 2009) New Revision: 3859
Modified: FormEncode/trunk/docs/Design.txt FormEncode/trunk/docs/ToDo.txt FormEncode/trunk/docs/Validator.txt FormEncode/trunk/docs/htmlfill.txt Log: Fixed a number of links in the documentation Modified: FormEncode/trunk/docs/Design.txt =================================================================== --- FormEncode/trunk/docs/Design.txt 2009-04-17 17:12:08 UTC (rev 3858) +++ FormEncode/trunk/docs/Design.txt 2009-04-17 20:48:21 UTC (rev 3859) @@ -24,15 +24,12 @@ nothing is done until everything validates, you can use this without transactions. -FormEncode generally works on primitive types (though you could extend -it to deal with your own types if you wish; `formencode.sqlschema -<module-formencode.sqlschema.html>`_ is an example of this). These -are things like strings, lists, dictionaries, integers, etc. This -fits in with look-before-you-leap; often your domain objects won't -exist until after you apply the user's request, so it's necessary to -work on an early form of the data. Also, FormEncode doesn't know -anything about your domain objects or classes; it's just easier to -keep it this way. +FormEncode generally works on primitive types. These are things like +strings, lists, dictionaries, integers, etc. This fits in with +look-before-you-leap; often your domain objects won't exist until +after you apply the user's request, so it's necessary to work on an +early form of the data. Also, FormEncode doesn't know anything about +your domain objects or classes; it's just easier to keep it this way. Validation only operates on a single "value" at a time. This is Python, collections are easy, and collections are themselves a single Modified: FormEncode/trunk/docs/ToDo.txt =================================================================== --- FormEncode/trunk/docs/ToDo.txt 2009-04-17 17:12:08 UTC (rev 3858) +++ FormEncode/trunk/docs/ToDo.txt 2009-04-17 20:48:21 UTC (rev 3859) @@ -33,12 +33,6 @@ * Make ``doctest_xml_compare`` work with wildcards/ellipses. Maybe with non-XHTML. -* Maybe include `wareweb.packing - <http://pythonpaste.org/wareweb/module-wareweb.packing.html>`_, - which is kind like like one-way validation for really small forms. - A compliment/alternative to `variabledecode - <module-formencode.variabledecode.html>`_. - * Some more ways to build validation. Validation from docstrings or method signatures. Modified: FormEncode/trunk/docs/Validator.txt =================================================================== --- FormEncode/trunk/docs/Validator.txt 2009-04-17 17:12:08 UTC (rev 3858) +++ FormEncode/trunk/docs/Validator.txt 2009-04-17 20:48:21 UTC (rev 3859) @@ -115,8 +115,7 @@ There's lots of validators. The best way to read about the individual validators available in the ``formencode.validators`` module is to -read the `validators generated documentation -<module-formencode.validators.html#classes>`_. +read about :module:`formencode.validators`. Compound Validators ------------------- @@ -504,13 +503,13 @@ When a failed validation occurs FormEncode tries to output the error message in the appropriate language. For this it uses the standard -`gettext <http://python.org/doc/current/lib/module-gettext.html>`_ -mechanism of python. To translate the message in the appropirate -message FormEncode has to find a gettext function that translates the -string. The language to be translated into and the used domain is -determined by the found gettext function. To serve a standard -translation mechanism and to enable custom translations it looks in -the following order to find a gettext (``_``) function: +`gettext <http://docs.python.org/library/gettext.html>`_ mechanism of +python. To translate the message in the appropirate message FormEncode +has to find a gettext function that translates the string. The +language to be translated into and the used domain is determined by +the found gettext function. To serve a standard translation mechanism +and to enable custom translations it looks in the following order to +find a gettext (``_``) function: 1. method of the ``state`` object @@ -577,15 +576,15 @@ HTTP/HTML Form Input -------------------- -The validation expects nested data structures; specifically `Schema -<class-formencode.schema.Schema.html>`_ and `ForEach -<class-formencode.foreach.ForEach.html>`__ deal with these structures -well. HTML forms, however, do not produce nested structures -- they -produce flat structures with keys (input names) and associated values. +The validation expects nested data structures; specifically +:class:`formencode.schema.Schema` and +:class:`formencode.foreach.ForEach` deal with these structures well. +HTML forms, however, do not produce nested structures -- they produce +flat structures with keys (input names) and associated values. -Validator includes the module `variabledecode -<module-formencode.variabledecode.html>`, which allows you to encode -nested dictionary and list structures into a flat dictionary. +Validator includes the module :module:`formencode.variabledecode`, +which allows you to encode nested dictionary and list structures into +a flat dictionary. To do this it uses keys with ``"."`` for nested dictionaries, and ``"-int"`` for (ordered) lists. So something like: @@ -626,10 +625,9 @@ with ``'-int'``, where they are ordered by the integer (the integers are used for sorting, missing numbers in a sequence are ignored). -`NestedVariables -<class-formencode.variabledecode.NestedVariables.html>`_ is a -validator that decodes and encodes dictionaries using this algorithm. -You can use it with a Schema's `pre_validators`_ attribute. +:class:`formencode.variabledecode.NestedVariables` is a validator that +decodes and encodes dictionaries using this algorithm. You can use it +with a Schema's `pre_validators`_ attribute. Of course, in the example we use the data is rather eclectic -- for instance, Tim Smith doesn't have his name separated into first and Modified: FormEncode/trunk/docs/htmlfill.txt =================================================================== --- FormEncode/trunk/docs/htmlfill.txt 2009-04-17 17:12:08 UTC (rev 3858) +++ FormEncode/trunk/docs/htmlfill.txt 2009-04-17 20:48:21 UTC (rev 3859) @@ -13,11 +13,11 @@ Introduction ============ -`htmlfill <module-formencode.htmlfill.html>`_ is a library to fill out -forms, both with default values and error messages. It's like a -template library, but more limited, and it can be used with the output -from other templates. It has no prerequesites, and can be used -without any other parts of FormEncode. +:mod:`formencode.htmlfill` is a library to fill out forms, both with default +values and error messages. It's like a template library, but more +limited, and it can be used with the output from other templates. It +has no prerequesites, and can be used without any other parts of +FormEncode. Usage ===== @@ -36,8 +36,7 @@ return the form to the user with the values they entered, in addition to errors. -See `formencode.htmlfill.render for more -<modules/htmlfill.html#formencode.htmlfill.render>`_ for more. +See :func:`formencode.htmlfill.render` for more. Errors ------ @@ -99,5 +98,5 @@ it, without reformatting it too much. If HTMLParser_ chokes on the code, so will htmlfill. -.. _HTMLParser: http://python.org/doc/current/lib/module-HTMLParser.html +.. _HTMLParser: http://docs.python.org/library/htmlparser.html ------------------------------------------------------------------------------ Stay on top of everything new and different, both inside and around Java (TM) technology - register by April 22, and save $200 on the JavaOne (SM) conference, June 2-5, 2009, San Francisco. 300 plus technical and hands-on sessions. Register today. Use priority code J9JMT32. http://p.sf.net/sfu/p _______________________________________________ FormEncode-CVS mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/formencode-cvs
