Menu
▾
▴
phpwiki-talk
|
From: Whit B. <wh...@tr...> - 2004-02-26 15:31:03
|
Hi all, Probably this is just a documentation request, but it would be really helpful if there were a good visualization of the inter-relation of PhpWiki's components, particularly the plugin design. The more I study it, the more I can sense that there's something really elegant here - but also the more it looks like any hacking of it requires an unusually thorough overview, since the simplest actions are atomized so as to involve a dozen files, so from the standpoint of wanting to add what in most scripted applications would be a simple hack in an obvious place -- well, here it requires a multi-layered appreciation of the design philosophy rather then just grepping for the obvious code that does something and then changing it. Well-written procedural code reads like a natural language, so doesn't need extensive visualization. (Okay, very little of it is well-written, but in principle....) Well-written OO like PhpWiki is much less natural-language-like and much more like physical devices, so we could really use a visual map of components, inheritences, dependencies, and what's alterable by plugins, as compared to what's hard-wired by the base code. I'd guess every member of the core team has a good visual map of the whole territory in mind. But has anyone committed that map to a sketch that can be shared? Whit |
|
From: Reini U. <ru...@x-...> - 2004-02-26 19:32:46
|
Whit Blauvelt schrieb: > Probably this is just a documentation request, but it would be really > helpful if there were a good visualization of the inter-relation of > PhpWiki's components, particularly the plugin design. That would be indeed very helpful. Once you are in it, you will admire it, but it needs some time to get into it... I think only three of use are really into it now (jeff - who wrote it, carsten and me). Some others caught the edges. Could be much more. And it changes so often. After this release I'll try do come up with a understandable code flowdiagram. Anyone please feel free to create a new PhpWiki page for this, like PhpWiki:CodeFlowDiagram. There's a static diagram needed (easy), like the map for the templates, but also a dynamic diagram, how and when the libs are processed. (main loop => page) > The more I study it, > the more I can sense that there's something really elegant here - but also > the more it looks like any hacking of it requires an unusually thorough > overview, since the simplest actions are atomized so as to involve a dozen > files, so from the standpoint of wanting to add what in most scripted > applications would be a simple hack in an obvious place -- well, here it > requires a multi-layered appreciation of the design philosophy rather then > just grepping for the obvious code that does something and then changing it. > > Well-written procedural code reads like a natural language, so doesn't need > extensive visualization. (Okay, very little of it is well-written, but in > principle....) Well-written OO like PhpWiki is much less > natural-language-like and much more like physical devices, so we could > really use a visual map of components, inheritences, dependencies, and > what's alterable by plugins, as compared to what's hard-wired by the base > code. I'd guess every member of the core team has a good visual map of the > whole territory in mind. But has anyone committed that map to a sketch that > can be shared? -- Reini Urban http://xarch.tu-graz.ac.at/home/rurban/ |
|
From: Sebastian B. <s-b...@gm...> - 2004-02-26 22:26:38
|
> Whit Blauvelt schrieb: > > Probably this is just a documentation request, but it would be really > > helpful if there were a good visualization of the inter-relation of > > PhpWiki's components, particularly the plugin design. > > That would be indeed very helpful. Once you are in it, you will admire > it, but it needs some time to get into it... Well, this ist something I asked for some weeks ago, and I am still looking thru the code (okay, still have some other exams to do, thus not much time...). I am thinking about writing down what I find out. Perhaps anybody ready to assist? Or should I setup a wiki-page for it? Kind regards. Sebastian |
|
From: Oliver B. <ob...@de...> - 2004-02-26 22:55:57
|
Reini Urban wrote: > Whit Blauvelt schrieb: > > Probably this is just a documentation request, but it would be really > > helpful if there were a good visualization of the inter-relation of > > PhpWiki's components, particularly the plugin design. > > That would be indeed very helpful. Once you are in it, you will admire > it, but it needs some time to get into it... Maybe a documentation tool like doxygen could help. I started using it in my last embedded project and it's really useful and very little effort to maintain. Besides putting special marked comments into the right places of the documentation, it generates nice cross reference lists or even graphs with AT&T's dot. I have to admit that using doxygen only for C programs, I'm not sure how good it is in extracting information from PHP code. If wanted, I could try it with the Phpwiki code. Do you think, Pwpwiki programmers would accept to use doxygen comments? This would make it even more useful as it is the intended use of doxygen... Oliver -- Oliver Betz, Muenchen |
|
From: electron <ele...@mg...> - 2004-02-27 07:17:04
|
Doxygen is fine. PhpWiki needs a BIG doc overhaul anyway. My suggestion to those who want to understand what is going on with = PhpWiki is to use an IDE (Integrated Development Environment). I use phpEd by nusphere.com. It comes with a professional version of the = php module DBG (2.16) which connects to apache and does code steping! There are other products like Zend Studio and open source ones like = phpEdit and a couple I can't remember. Each works well. Komodo deserves a = mention. There are PEAR modules to help debugging as well and a couple of others. All things need to be evaluated based on cost and setup. (Hence why I = choose phped!) -Jtp I've stopped 7,398 spam messages. You can too! One month FREE spam protection at http://www.cloudmark.com/spamnetsig/} -----Original Message----- From: php...@li... [mailto:php...@li...] On Behalf Of Oliver = Betz Sent: Thursday, February 26, 2004 4:54 PM To: php...@li... Subject: Re: [Phpwiki-talk] Is there a flow diagram for the components? Reini Urban wrote: > Whit Blauvelt schrieb: > > Probably this is just a documentation request, but it would be = really > > helpful if there were a good visualization of the inter-relation of > > PhpWiki's components, particularly the plugin design.=20 >=20 > That would be indeed very helpful. Once you are in it, you will = admire=20 > it, but it needs some time to get into it... Maybe a documentation tool like doxygen could help. I started using it in my last embedded project and it's really useful=20 and very little effort to maintain. Besides putting special marked=20 comments into the right places of the documentation, it generates=20 nice cross reference lists or even graphs with AT&T's dot. I have to admit that using doxygen only for C programs, I'm not sure=20 how good it is in extracting information from PHP code. If wanted, I could try it with the Phpwiki code. Do you think, Pwpwiki programmers would accept to use doxygen=20 comments? This would make it even more useful as it is the intended=20 use of doxygen... Oliver --=20 Oliver Betz, Muenchen |
|
From: <jw...@fi...> - 2004-02-27 09:20:14
Attachments:
phpwiki_architecture.png
|
Hello, A while ago i did the attached drawing of the sequential flow within = phpwiki This was a first draft as I didn't get time to continue, but it may help = for the doc overhaul. I can send the visio version to those who want it (sorry I hadn't = installed Dia at the time..) J=E9r=F4me -----Message d'origine----- De=A0: php...@li... [mailto:php...@li...] De la part de electron Envoy=E9=A0: vendredi 27 f=E9vrier 2004 08:15 =C0=A0: php...@li... Objet=A0: RE: [Phpwiki-talk] Is there a flow diagram for the components? Doxygen is fine. PhpWiki needs a BIG doc overhaul anyway. My suggestion to those who want to understand what is going on with = PhpWiki is to use an IDE (Integrated Development Environment). I use phpEd by nusphere.com. It comes with a professional version of the = php module DBG (2.16) which connects to apache and does code steping! There are other products like Zend Studio and open source ones like = phpEdit and a couple I can't remember. Each works well. Komodo deserves a = mention. There are PEAR modules to help debugging as well and a couple of others. All things need to be evaluated based on cost and setup. (Hence why I = choose phped!) -Jtp I've stopped 7,398 spam messages. You can too! One month FREE spam protection at http://www.cloudmark.com/spamnetsig/} -----Original Message----- From: php...@li... [mailto:php...@li...] On Behalf Of Oliver = Betz Sent: Thursday, February 26, 2004 4:54 PM To: php...@li... Subject: Re: [Phpwiki-talk] Is there a flow diagram for the components? Reini Urban wrote: > Whit Blauvelt schrieb: > > Probably this is just a documentation request, but it would be = really > > helpful if there were a good visualization of the inter-relation of > > PhpWiki's components, particularly the plugin design.=20 >=20 > That would be indeed very helpful. Once you are in it, you will = admire=20 > it, but it needs some time to get into it... Maybe a documentation tool like doxygen could help. I started using it in my last embedded project and it's really useful=20 and very little effort to maintain. Besides putting special marked=20 comments into the right places of the documentation, it generates=20 nice cross reference lists or even graphs with AT&T's dot. I have to admit that using doxygen only for C programs, I'm not sure=20 how good it is in extracting information from PHP code. If wanted, I could try it with the Phpwiki code. Do you think, Pwpwiki programmers would accept to use doxygen=20 comments? This would make it even more useful as it is the intended=20 use of doxygen... Oliver --=20 Oliver Betz, Muenchen ------------------------------------------------------- SF.Net is sponsored by: Speed Start Your Linux Apps Now. Build and deploy apps & Web services for Linux with a free DVD software kit from IBM. Click Now! http://ads.osdn.com/?ad_id=1356&alloc_id438&op=CCk _______________________________________________ Phpwiki-talk mailing list Php...@li... https://lists.sourceforge.net/lists/listinfo/phpwiki-talk |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X