Hi
for quite some time I was thinking about way we provide documentation
and I think there is lot of place for improvements.
As my current favorite tool to build documentation is Sphinx
<http://sphinx.pocoo.org/>, I gave it a try. To name some of the
benefits let me quote from their home page:
* Output formats: HTML (including Windows HTML Help), LaTeX (for
printable PDF versions), manual pages, plain text
* Extensive cross-references: semantic markup and automatic links for
functions, classes, citations, glossary terms and similar pieces of
information
* Hierarchical structure: easy definition of a document
tree, with automatic links to siblings, parents and children
* Automatic indices: general index as well as a module index
* Built-in fulltext search
I've done quick and dirty [*] conversion of FAQ and few introductory
sections, you can find source here:
https://github.com/nijel/phpmyadmin-doc
And the generated documentation in HTML and PDF here:
http://tmp.cihar.com/pmadoc/index.htmlhttp://tmp.cihar.com/phpMyAdmin.pdf
What do you think about changing our documentation from HTML to
something else (be it Sphinx, Docbook or something completely else)?
[*] I've lost all text formatting and links in text, but that should
not be hard to convert properly, I just did not want to spend much time
on prototype.
--
Michal Čihař | http://cihar.com | http://phpmyadmin.cz
Hi Rouslan and list,
I wonder whether this is a bug or a missing feature :) but I noticed
that in some situations, for example following a foreign link or picking
a table from the output of db_structure.php, the navi panel does not
position itself to the new table.
--
Marc Delisle
http://infomarc.info
Hi Mark,
Its surely unintential bug :) because as the curr_db is sent through
the GET method so we arnt loosing it but we are not keeping up with it
when we jump to the field.
This is what i managed to carve out. :)
May be we should post a form for each link clicking along with a
hidden input depicting the db context on which it has to be switched
iff it is a case with $REQUEST. (this could be an easy workout
solution)
- Regards
Dron Rathore
Thanks Mark for showing interest. :)
well the parser has a 2 things to offer:
1. Auto completing syntaxes.
2. Figure out and notify the user about basic and a bit more specific
syntax errors. Specific, like for a create table syntax, every colum
must have a datatype defined and so on.
The parser can help if implemented on both client/server side in not
sparing a query for no use on the server and the db can be utilised in
that time for some usefull work(we can do this for atleast the silly
mistakes but i am coding it for major).
Well, i havnt pulled the request yet because i am testing it through
various tests, will update soon.
- Regards
Dron Rathore
On 11/28/12, phpmyadmin-devel-request(a)lists.sourceforge.net
<phpmyadmin-devel-request(a)lists.sourceforge.net> wrote:
> Send Phpmyadmin-devel mailing list submissions to
> phpmyadmin-devel(a)lists.sourceforge.net
>
> To subscribe or unsubscribe via the World Wide Web, visit
> https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
> or, via email, send a message with subject or body 'help' to
> phpmyadmin-devel-request(a)lists.sourceforge.net
>
> You can reach the person managing the list at
> phpmyadmin-devel-owner(a)lists.sourceforge.net
>
> When replying, please edit your Subject line so it is more specific
> than "Re: Contents of Phpmyadmin-devel digest..."
>
>
> Today's Topics:
>
> 1. Sql Validator (Dron Rathore)
> 2. Re: Sql Validator (Rouslan Placella)
> 3. Re: Sql Validator (Marc Delisle)
> 4. Re: Sql Validator (Rouslan Placella)
> 5. [SPAM] Re: Sql Validator (Marc Delisle)
> 6. navi panel and current table (Marc Delisle)
> 7. Re: navi panel and current table (Rouslan Placella)
> 8. Re: navi panel and current table (Marc Delisle)
>
>
> ----------------------------------------------------------------------
>
> Message: 1
> Date: Tue, 27 Nov 2012 21:38:20 +0800
> From: Dron Rathore <dron.rathore(a)gmail.com>
> Subject: [Phpmyadmin-devel] Sql Validator
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID:
> <CAK4icChoWY-kmfVODai9p6H+9LWZAe7W=++0O9Wn3Pb5x_S1Hg(a)mail.gmail.com>
> Content-Type: text/plain; charset=ISO-8859-1
>
> Hi all!,
> i wanted to know that is there any sql parser to validate queries
> before firing them? I guess there is one which uses zend.
> Actually i have coded a parser(client side js validator, can work as
> JIT, i can transform it into php codes too) and eager to share it with
> pma.
> - Regards
> Dron Rathore
>
>
>
> ------------------------------
>
> Message: 2
> Date: Tue, 27 Nov 2012 13:47:09 +0000
> From: Rouslan Placella <rouslan(a)placella.com>
> Subject: Re: [Phpmyadmin-devel] Sql Validator
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B4C45D.1050700(a)placella.com>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> On 27/11/12 13:38, Dron Rathore wrote:
>> Hi all!,
>> i wanted to know that is there any sql parser to validate queries
>> before firing them? I guess there is one which uses zend.
>> Actually i have coded a parser(client side js validator, can work as
>> JIT, i can transform it into php codes too) and eager to share it with
>> pma.
>> - Regards
>> Dron Rathore
>
> Hi Dron,
>
> What is the purpose of validating queries? If the query is invalid MySQL
> will just throw an error.
>
> Besides, we already have an SQL parser in the code base...
>
> Byem
> Rouslan
>
>
>
> ------------------------------
>
> Message: 3
> Date: Tue, 27 Nov 2012 10:25:17 -0500
> From: Marc Delisle <marc(a)infomarc.info>
> Subject: Re: [Phpmyadmin-devel] Sql Validator
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B4DB5D.8000804(a)infomarc.info>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> Rouslan Placella a ?crit :
>> On 27/11/12 13:38, Dron Rathore wrote:
>>> Hi all!,
>>> i wanted to know that is there any sql parser to validate queries
>>> before firing them? I guess there is one which uses zend.
>>> Actually i have coded a parser(client side js validator, can work as
>>> JIT, i can transform it into php codes too) and eager to share it with
>>> pma.
>>> - Regards
>>> Dron Rathore
>>
>> Hi Dron,
>>
>> What is the purpose of validating queries? If the query is invalid MySQL
>> will just throw an error.
>
> One of the goals is to verify whether the query is compliant with
> standard SQL, which is not the same as MySQL. Look for "Validator" in
> Documentation.html.
>>
>> Besides, we already have an SQL parser in the code base...
>>
>> Byem
>> Rouslan
>
>
> --
> Marc Delisle
> http://infomarc.info
>
>
>
> ------------------------------
>
> Message: 4
> Date: Tue, 27 Nov 2012 15:34:01 +0000
> From: Rouslan Placella <rouslan(a)placella.com>
> Subject: Re: [Phpmyadmin-devel] Sql Validator
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B4DD69.1050608(a)placella.com>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> On 27/11/12 15:25, Marc Delisle wrote:
>> Rouslan Placella a ?crit :
>>> On 27/11/12 13:38, Dron Rathore wrote:
>>>> Hi all!,
>>>> i wanted to know that is there any sql parser to validate queries
>>>> before firing them? I guess there is one which uses zend.
>>>> Actually i have coded a parser(client side js validator, can work as
>>>> JIT, i can transform it into php codes too) and eager to share it with
>>>> pma.
>>>> - Regards
>>>> Dron Rathore
>>>
>>> Hi Dron,
>>>
>>> What is the purpose of validating queries? If the query is invalid MySQL
>>> will just throw an error.
>>
>> One of the goals is to verify whether the query is compliant with
>> standard SQL, which is not the same as MySQL. Look for "Validator" in
>> Documentation.html.
>>>
>>> Besides, we already have an SQL parser in the code base...
>>>
>
> Ok, I see.
>
> Bye,
> Rouslan
>
>
>
> ------------------------------
>
> Message: 5
> Date: Tue, 27 Nov 2012 12:47:50 -0500
> From: Marc Delisle <marc(a)infomarc.info>
> Subject: [Phpmyadmin-devel] [SPAM] Re: Sql Validator
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B4FCC6.1060802(a)infomarc.info>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> Dron Rathore a ?crit :
>> Hi all!,
>> i wanted to know that is there any sql parser to validate queries
>> before firing them? I guess there is one which uses zend.
>> Actually i have coded a parser(client side js validator, can work as
>> JIT, i can transform it into php codes too) and eager to share it with
>> pma.
>> - Regards
>> Dron Rathore
>
> So Dron, where would your parser fit into phpMyAdmin?
> - code completion in the query windows?
> - validation ?
> - syntax highlighting?
>
>
> --
> Marc Delisle
> http://infomarc.info
>
>
>
> ------------------------------
>
> Message: 6
> Date: Tue, 27 Nov 2012 12:55:17 -0500
> From: Marc Delisle <marc(a)infomarc.info>
> Subject: [Phpmyadmin-devel] navi panel and current table
> To: phpmyadmin-devel(a)lists.sf.net
> Message-ID: <50B4FE85.6090905(a)infomarc.info>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> Hi Rouslan and list,
>
> I wonder whether this is a bug or a missing feature :) but I noticed
> that in some situations, for example following a foreign link or picking
> a table from the output of db_structure.php, the navi panel does not
> position itself to the new table.
>
> --
> Marc Delisle
> http://infomarc.info
>
>
>
> ------------------------------
>
> Message: 7
> Date: Tue, 27 Nov 2012 20:28:01 +0000
> From: Rouslan Placella <rouslan(a)placella.com>
> Subject: Re: [Phpmyadmin-devel] navi panel and current table
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B52251.9080209(a)placella.com>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> On 27/11/12 17:55, Marc Delisle wrote:
>> Hi Rouslan and list,
>>
>> I wonder whether this is a bug or a missing feature :) but I noticed
>> that in some situations, for example following a foreign link or picking
>> a table from the output of db_structure.php, the navi panel does not
>> position itself to the new table.
>
> Sorry, but I don't understand what you mean.
>
> Bye,
> Rouslan
>
>
>
>
> ------------------------------
>
> Message: 8
> Date: Wed, 28 Nov 2012 08:53:58 -0500
> From: Marc Delisle <marc(a)infomarc.info>
> Subject: Re: [Phpmyadmin-devel] navi panel and current table
> To: phpmyadmin-devel(a)lists.sourceforge.net
> Message-ID: <50B61776.7020007(a)infomarc.info>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> Rouslan Placella a ?crit :
>> On 27/11/12 17:55, Marc Delisle wrote:
>>> Hi Rouslan and list,
>>>
>>> I wonder whether this is a bug or a missing feature :) but I noticed
>>> that in some situations, for example following a foreign link or picking
>>> a table from the output of db_structure.php, the navi panel does not
>>> position itself to the new table.
>>
>> Sorry, but I don't understand what you mean.
>
> Example 1:
> - in navi, click on sakila
> - in main, click on the Browse Action on the actor line
> - navi should show that actor is the current table
>
> Example 2:
> - in navi, click on sakila
> - in navi, under sakila, click on Tables then click on inventory
> - in main, for inventory_id 1, click on the film_id 1
> - now, in main you are seeing a row from film, but the navi panel no
> longer shows that the current db is sakila
>
>
> --
> Marc Delisle
> http://infomarc.info
>
>
>
> ------------------------------
>
> ------------------------------------------------------------------------------
> Keep yourself connected to Go Parallel:
> INSIGHTS What's next for parallel hardware, programming and related areas?
> Interviews and blogs by thought leaders keep you ahead of the curve.
> http://goparallel.sourceforge.net
>
> ------------------------------
>
> _______________________________________________
> Phpmyadmin-devel mailing list
> Phpmyadmin-devel(a)lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
>
>
> End of Phpmyadmin-devel Digest, Vol 76, Issue 11
> ************************************************
>
Thanks for showing interest. :)
well the parser has a 2 things to offer:
1. Auto completing syntaxes.
2. Figure out and notify the user about basic and a bit more specific
syntax errors. Specific, like for a create table syntax, every colum
must have a datatype defined and so on.
The parser can help if implemented on both client/server side in not
sparing a query for no use on the server and the db can be utilised in
that time for some usefull work(we can do this for atleast the silly
mistakes but i am coding it for major).
Well, i havnt pulled the request yet because i am testing it through
various tests, will update soon.
Hi all!,
i wanted to know that is there any sql parser to validate queries
before firing them? I guess there is one which uses zend.
Actually i have coded a parser(client side js validator, can work as
JIT, i can transform it into php codes too) and eager to share it with
pma.
- Regards
Dron Rathore
Hi,
It's still a few months, but I was wondering if any of you are
planning to attend FOSDEM 2013 [0], which will be held in the weekend
of February 2nd and 3rd 2013 at ULB Campus Solbosch in Brussels,
Belgium?
[0] http://fosdem.org/2013/
--
Kind regards,
Dieter Adriaenssens