www.typo3apprentice.com TS Reference Now in Development

2010 January 2 | Filed in: Typoscript, Documentation, Blog, cObjects Christopher Torgalson

Announcing the embryonic www.typo3apprentice.com TS Reference; pleading with the www.typo3.org maintainers to better manage core document upgrades.

The www.typo3apprentice.com Typoscript Reference is currently a work in progress. The plan is to develop three major sections over time:

  1. the cObject Reference,
  2. the TS Function Reference,
  3. the Menu Reference

The development of a TS reference separate from the authoritative TSref was motivated by that document's annoying habit of completely changing its link structure with every new release without providing proper 301 redirects. This made many of the most important links in the articles here–and those in many other articles and blog posts on the web–obsolete, making some of the articles close to useless.

Readers are invited to request that the maintainers of www.typo3.org read Jakob Nielsen's (ten-year old!) comments on URLs and plan upgrades to the TSref (and other important docs!) accordingly:

Do not move pages around but keep them at the same URL: it is very annoying for authors of other sites when their links either stop working or turn into pointers to something different because the original page has been moved and replaced by something new. There can be reasons to reserve a special URL for the current edition of a column or other special content, but the article should be stored at a permanent URL from the start and this URL should be listed on the page that is accessed through the temporary or varying URL.

Henceforth on this site, all links to Typoscript documentation will be links either to

  1. "External URL" type pages on www.typo3apprentice.com (i.e. which redirect to the appropriate page in the TSref and which only require me to change those pages rather than every link in every blog post and article on the site), or
  2. short articles on the relevant cObject or function with links to the authoritative documents on www.typo3.org.

Readers are also invited to report broken or obsolete links on this site.

In the future if all goes well, I may expand the TS Reference here to include conditions and other parts of the main TSref documentation, and perhaps open the Reference to comments.

Comments

www.typo3apprentice.com
A Bedlam Hotel project © 2007—2012

Report a problem with this page

Bookmark and Share