Documented the mailing list. Documented how the program handles illegal initial namespaces. Documented the semantics of LegalVals in the case of the NAMESPACE variable.

Fork: 0

tundra / tconfpy

Browse code Documented the mailing list. Documented how the program handles illegal initial namespaces. Documented the semantics of LegalVals in the case of the NAMESPACE variable. master
1 parent 8aace17 commit 4483ab595cd2f44b2c1f9b9cf920feaa3dc16f4c tundra authored on 14 Apr 2004

Patch

Unified Split

Showing 1 changed file

                Ignore Space
               Show notes
              View
            
          
          45 ■■■■■
          tconfpy.3
 to know about namespaces and the \'NAMESPACE\' variable:
 
 
.IP \(bu 4
You can manually set the initial namespace to something other than
"".  You do this  by creating the \'NAMESPACE\' variable in the initial
You can manually set the initial namespace to something other than "".
You do this by creating the \'NAMESPACE\' variable in the initial
symbol table passed to the parser, and setting the \'Value\' attribute
of its descriptor to whatever you want as the initial namespace.
of its descriptor to whatever you want as the initial namespace.  At
startup \*(TC will check this initial value to make sure it conforms
to the rules for properly formed names - i.e., It it will check for
blank space, a leading \'$\, the presence of square brackets, and so
on.  If the initial namespace value you provide is illegal, \*(TC will
produce an error and reset the initial namespace to "".
 
.IP \(bu 4
Each time the user enters a new namespace, it is added to the
\'LegalVals\' attribute of the \'NAMESPACE\' variable descriptor.
This is done to keep a "history" of all namespaces encountered during
parsing.
 
.IP \(bu 4
The semantics of \'LegalVals\' are slightly different than usual
in the case of the \'NAMESPACE\' variable.  As described above, the
presence of anything in \'LegalVals\' ordinarily means that the
variable in question is limited to one of those values.  However,
in the case of \'NAMESPACE\'
.B this is only true if \'AllowNewNamespaces=False\' is passed to the API.
In other words, if \'AllowNewNamespaces=True\' (default), the user can
create new namespaces of their own choosing - i.e., They can create
namespaces not yet in \'LegalVals\'.  In this case, \'LegalVals\'
is just a list of all the namespaces they created.
 
.IP \(bu 4
If you are inhibiting the creation of new namespaces (via the
\'AllowNewNamespaces = False\' option described below) you can
 
 
 
 
.SH THE \*(TC MAILING LIST
 
TundraWare Inc. maintains a mailing list to help you with your
\*(TC questions and bug reports.  To join the list, send email
to 
.B majordomo@tundraware.com
with a single line of text in the body (not the Subject line)
of the message:
 
.nf
    subscribe tconfpy-users your-email-address-goes-here
.fi
 
You will be notified when your subscription has been approved.  You
will also receive detailed information about how to use the list,
access archives of previous messages, unsubscribe, and so on.
 
.SH OTHER
 
\*(TC requires Python 2.3 or later.
 to know about namespaces and the \'NAMESPACE\' variable:
 .IP \(bu 4
+You can manually set the initial namespace to something other than
+"".  You do this  by creating the \'NAMESPACE\' variable in the initial
+You can manually set the initial namespace to something other than "".
+You do this by creating the \'NAMESPACE\' variable in the initial
 symbol table passed to the parser, and setting the \'Value\' attribute
+of its descriptor to whatever you want as the initial namespace.
+of its descriptor to whatever you want as the initial namespace.  At
+startup \*(TC will check this initial value to make sure it conforms
+to the rules for properly formed names - i.e., It it will check for
+blank space, a leading \'$\, the presence of square brackets, and so
+on.  If the initial namespace value you provide is illegal, \*(TC will
+produce an error and reset the initial namespace to "".
 .IP \(bu 4
 Each time the user enters a new namespace, it is added to the
 \'LegalVals\' attribute of the \'NAMESPACE\' variable descriptor.
 This is done to keep a "history" of all namespaces encountered during
 parsing.
+.IP \(bu 4
+The semantics of \'LegalVals\' are slightly different than usual
+in the case of the \'NAMESPACE\' variable.  As described above, the
+presence of anything in \'LegalVals\' ordinarily means that the
+variable in question is limited to one of those values.  However,
+in the case of \'NAMESPACE\'
+.B this is only true if \'AllowNewNamespaces=False\' is passed to the API.
+In other words, if \'AllowNewNamespaces=True\' (default), the user can
+create new namespaces of their own choosing - i.e., They can create
+namespaces not yet in \'LegalVals\'.  In this case, \'LegalVals\'
+is just a list of all the namespaces they created.
 .IP \(bu 4
 If you are inhibiting the creation of new namespaces (via the
 \'AllowNewNamespaces = False\' option described below) you can
+.SH THE \*(TC MAILING LIST
+TundraWare Inc. maintains a mailing list to help you with your
+\*(TC questions and bug reports.  To join the list, send email
+to
+.B majordomo@tundraware.com
+with a single line of text in the body (not the Subject line)
+of the message:
+.nf
+    subscribe tconfpy-users your-email-address-goes-here
+.fi
+You will be notified when your subscription has been approved.  You
+will also receive detailed information about how to use the list,
+access archives of previous messages, unsubscribe, and so on.
 .SH OTHER
 \*(TC requires Python 2.3 or later.

Show line notes below