Translations
Info
All page names need to be in English.
en da  de  fr  it  ja  km  nl  ru  zh

Naming scheme

From TYPO3Wiki
Jump to: navigation, search
This page belongs to the Extension coordination team (category ECT)

Naming scheme for library

It shall be straight and clearly categorize contained code.

  • lib.menu.text
  • lib.menu.graphic
  • lib.sitemap

Another option would be to include the creators name into the package name, i.e.:

  • lib.menu.text.creator.version
  • lib.menu.graphic.creator.version
  • lib.sitemap.creator.version


The option to include the creators name (or even a companys name) is a good way to animate some more big players to participate and share their code. There a several possibilities to do this:

  • lib.menu.css.text.horizontal.version.creator
  • lib.menu.css.text.horizontal.creator.version
  • lib.menu.css.text.creator.horizontal.version

where creator is the companys webadress in java package style I guess the best one is the one Matthias posted already above.

  • Example: lib.menu.css.text.horizontal.org.typo3.www.0.0.1

Comment (Mstuebner 23:53, 22 June 2007 (CEST)): I would think that the package name with the reverse domain is far too long (imagine a long URL too!). This would be written in the documentation instead to strech the name endless.

As to my knowledge the most often changed part should come last (think about sorting) the version number should be at the end.

  • Example: lib.menu.css.text.horizontal.creator.0.0.1

Comment (Sboettger): I also think taht the packages could get pretty long then. But we shouldn't forget the marketing affect of the author. Even with a long url, it's no problem to copy paste it to your own typoscript and use a copy of the lib.

  • Example: temp.menu.horizontal < lib.menu.css.text.horizontal.this.is.a.really.long.url.who.is.the.author.of.this.package.0.0.1

Extensions have just shortcuts of the authorname (like creator), and I'd say that the big players rarely participate in sharing. We need to find a way how to get these big players into the community boat.


Comment (Mstuebner 00:12, 23 June 2007 (CEST)): Having the full URL/Adress/Bank account in documentation would be one more chance to HAVE a documentation, what is mostly not done otherwise!