Hint for documentation of command: legal database names
Tuesday, 6 March 2012 · 3 messages
AR
Andreas Rulle6 Mar 2012 12:14 #
Dear BaseX team,
in this mail you receive a small suggestion for the command documentation
http://docs.basex.org/wiki/Commands#CREATE_DATABASE
The comment from the source code, see the class org.basex.core.Command and its method validName,
"allows only letters, digits, the underscore, and dash."
could be added as information about legal characters for database names to the page http://docs.basex.org/wiki/Commands#CREATE_DATABASE .
Okay it is a wiki and therefore could be editited directly, but I want to inform the team about this
suggetion first. Perhaps the page could have a paragraph "legal identifiers".
With best regards
Andreas
JE
Jens Erat6 Mar 2012 12:23 #
Hi Andreas,
thanks for your suggestion about improving our documentation. I just added a hint about valid database names.
Maybe we will create a page defining legal identifiers; what are @the others of BaseX-Team thinking about this? Currently this information is kind of wide-spread all over the documentation including multiple occurrences of the same information.
Kind regards from Lake Constance, Germany,
Jens Erat
--
Jens Erat
[phone]: tel:+49-151-56961126
[mail]: mailto:email at jenserat.de
[jabber]: xmpp:jabber at jenserat.de
[web]: http://www.jenserat.de
PGP: 350E D9B6 9ADC 2DED F5F2 8549 CBC2 613C D745 722B
Quoted text · Andreas Rulle · 28 lines
Am 06.03.2012 um 12:14 schrieb Andreas Rulle: > Dear BaseX team, > > in this mail you receive a small suggestion for the command documentation > > http://docs.basex.org/wiki/Commands#CREATE_DATABASE > > The comment from the source code, see the class org.basex.core.Command > and its method validName, > > "allows only letters, digits, the underscore, and dash." > > could be added as information about legal characters for database names to the page http://docs.basex.org/wiki/Commands#CREATE_DATABASE . > > Okay it is a wiki and therefore could be editited directly, but I want to inform the team about this > suggetion first. Perhaps the page could have a paragraph "legal identifiers". > > With best regards > > Andreas > > > > > _______________________________________________ > BaseX-Talk mailing list > BaseX-Talk at mailman.uni-konstanz.de > https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk
CG
Christian Grün6 Mar 2012 12:36 #
Hi Andreas,
thanks for your suggestion; you are always welcome to edit our Wiki if you encounter similar issues.
...hi Jens,
Quoted text · Jens Erat · 1 line
> Maybe we will create a page defining legal identifiers; what are @the others of BaseX-Team thinking about this? Currently this information is kind of wide-spread all over the documentation including multiple occurrences of the same information.
I like the idea! And I agree, there's already quite a lot of information that could be handled more consistently.
Thanks,
Christian
Written for BaseX 7.1. BaseX may have changed since: please check the current documentation.
⚡Generated with XQuery