[Typo3-documentation] Extension Documentation

Christian Trabold trabold at mehrwert.de
Tue Jul 20 16:33:22 CEST 2004


Hi!

> OK, here's a list of possible URLs:
> 
> (1) http://wiki.typo3.org/index.php/tt_news
> (2) http://wiki.typo3.org/index.php/tx_ttnews
> (3) http://wiki.typo3.org/index.php/ext/tx_ttnews
> 
> Please vote and explain why you vote like that.

Hmmm. After a while I came up to no real decision. And that's why:

I think, it's really important, how users can interact with the wiki 
(say by simply changing the url) and how logical it is structured. I 
don't see a real bulletproof solution for that in the examples above.


The first method could be a pitfall (as Ingmar mentioned earlier), if 
you just want to show the ext-manual here.

The second is very complex and hard to understand (there is no extension 
  tx_ttnews nor ttnews -> confusing).

The third is the best one, but it seems to keep a redundance. The prefix 
tx_ already says that it is an extension. And so does the folder ext/. 
There is no need for a tx_ prefix in the third method IMHO.



But here's an example of what I meant earlier. What do you think about 
these two URL "concepts"?

http://wiki.typo3.org/index.php/tt_news
-> find anything about tt_news incl. tutorials, manual etc.


http://wiki.typo3.org/index.php/tt_news/documentation/
-> the place for docs about the plugin tt_news


http://wiki.typo3.org/index.php/tt_news/documentation/manual
-> the place of the manual for tt_news



Or the other way around:

<http://wiki.typo3.org/index.php/documentation/>
-> points to a page with all typo3-related documents


<http://wiki.typo3.org/index.php/documentation/extensions/>
-> all extension docs


<http://wiki.typo3.org/index.php/documentation/extensions/tt_news/>
-> all tt_news docs


<http://wiki.typo3.org/index.php/documentation/extensions/tt_news/manual/>
-> tt_news manual

<http://wiki.typo3.org/index.php/documentation/extensions/tx_mynews/>
-> manual for my news ext



These are just my few cents. Maybe you'll find it valuable.


Regards,

Christian



PS: Why is the index.php visible? Is something like realURL possible?



More information about the TYPO3-project-documentation mailing list