Page 1 of 1
Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Mon Apr 19, 2010 2:41 pm
by Waher
I am looking for a platform to build a manual and function reference for my open source software-in-development. Something that is easily organized. I spotted a very nice and simple solution here:
http://mpdf1.com/manual/index.php
But contacting the author has not resulted in information what that software is and by the look of it, it looks custom. I suppose a Wiki could do that job in a way, but a Wiki is not exactly the thing I am looking for.
Any assistance would be welcome, this was a very tough topic to search in Google considering that reference and manual often led to actual programming language references and manuals.
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Mon Apr 19, 2010 3:55 pm
by mikosiko
any wiki tool will do a good job for what you describe... why is no an option for you?... just curious
Miko
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Mon Apr 19, 2010 4:23 pm
by Waher
mikosiko wrote:any wiki tool will do a good job for what you describe... why is no an option for you?... just curious
Miko
It is more difficult to manage, I want a more book-like format that may or may not be linked, similarly to what the above documentation is in the link I provided. I am surprised there isn't anything like this out there, because things like glossaries and references to functions would be something of use (like how php.net handles it, another good example). I tried to maintain a wiki for that purpose, it can work but not the way I'd like it to.
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Tue Apr 20, 2010 5:59 am
by josh
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Tue Apr 20, 2010 10:39 am
by alex.barylski
I assume you have looked into phpDocumentor? I know it's not the best thing in the world but it makes building documentation like php.net very easy if you use inline comments.
I'd be interested in hearing why this *wouldn't* work for you???
Cheers,
Alex
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Tue Apr 20, 2010 1:30 pm
by Waher
PCSpectra wrote:I assume you have looked into phpDocumentor? I know it's not the best thing in the world but it makes building documentation like php.net very easy if you use inline comments.
I'd be interested in hearing why this *wouldn't* work for you???
Cheers,
Alex
Because I simply need more than that. phpDocumentor is good for another developer, but it is not good for an adopter or user of an API or for manuals. All I am really looking for is an application I could use to build a web based document tree (with possible option to add comments to all documents, similarly to how PHP.net has comments under reference articles). Wiki has problems with commenting and the entire tree structure takes too much work and cross-referencing and linking and it is difficult to convert into a manual.
Seriosuly, phpDocumentor or wiki can 'work' for me, but I am simply looking for something better and more suitable to my needs. While the link I gave above does not have commenting option, software that functions like that or similarly to that would be most suitable, but I cannot seem to find anything that even remotely resembles that.
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Wed Apr 21, 2010 12:48 am
by CliveRush
Hello,
According to me w3school would be the best for php/mySQL. You can get all the basic information about the php/mySQL.
Thanks
Clive Rush
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Wed Apr 21, 2010 1:30 am
by Waher
CliveRush wrote:Hello,
According to me w3school would be the best for php/mySQL. You can get all the basic information about the php/mySQL.
Thanks
Clive Rush
I am not looking for reference for PHP or MySQL. I am looking for a tool that is PHP/MySQL based that I can use to build reference and manual documents for my own open source software.
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Fri Apr 23, 2010 2:27 am
by josh
Waher wrote:
Because I simply need more than that. phpDocumentor is good for another developer, but it is not good for an adopter or user of an API or for manuals. All I am really looking for is an application I could use to build a web based document tree (with possible option to add comments to all documents, similarly to how PHP.net has comments under reference articles). Wiki has problems with commenting and the entire tree structure takes too much work and cross-referencing and linking and it is difficult to convert into a manual.
You contradicted yourself. You said you like php.net. php.net uses phpdocumentor. That's why I linked you docbook. Comments is something they added on to it. Zend Framework did it too. That should be in your ball park, phpdocumentor is a documentation writing tool, not a commenting system. There are plenty of good commenting systems you can easily integrate with it.
Re: Anyone knows a good web-based PHP/MySQL reference tool?
Posted: Fri Apr 23, 2010 7:15 am
by Waher
josh wrote:Waher wrote:
Because I simply need more than that. phpDocumentor is good for another developer, but it is not good for an adopter or user of an API or for manuals. All I am really looking for is an application I could use to build a web based document tree (with possible option to add comments to all documents, similarly to how PHP.net has comments under reference articles). Wiki has problems with commenting and the entire tree structure takes too much work and cross-referencing and linking and it is difficult to convert into a manual.
You contradicted yourself. You said you like php.net. php.net uses phpdocumentor. That's why I linked you docbook. Comments is something they added on to it. Zend Framework did it too. That should be in your ball park, phpdocumentor is a documentation writing tool, not a commenting system. There are plenty of good commenting systems you can easily integrate with it.
I am getting a little confused here, researching a bit from Google it seems that it is not actually phpdocumentor that they are using (which actually is 'a commenting system', generating documentation from scripts), instead they are using PhD (PHP-based DocBook Renderer). But that aside, you did help me here to get on the right track with the keyword of 'docbook', I had not heard of PhD before now and will be looking into it. Thanks!