[TYPO3-doc] Domain model for documentation

[Jacob Floyd]

On Saturday, July 28, 2012 11:35:07 AM UTC-6, François Suter wrote:
>
> > I think a version parseable by version_compare() 
> > (http://php.net/version_compare) would be helpful. But on the other 
> > hand we could also completely go without a version field and just use 
> > a timestamp. What would be interesting in the future is some way to 
> > relate the document to a package ("applies to FLOW3 version x"). 
>
> We definitely need a version as we *do* want manuals to relate to 
> specific versions (and packages, there's a "packageKey" field in the 
> model). It's maybe not an issue you have now with FLOW3 now, but it is 
> for the existing TYPO3 official documentation (which relates to a given 
> version of TYPO3) and also for extension manual. 
>
> It's a good idea to take version_compare() as a reference. 
>

Versioning the manuals is great. I suspect the manual would have its own 
versions and not follow the TYPO3 version-scheme, right?
That way we can say that v2.5.3 of the TSRef applies to TYPO3 4.5-4.7 and 
v3.5.3 applies to TYPO3 6.0 or some such.

Or would we want some other scheme that is intertwined with the TYPO3 
version number?

With the FLOW3 docs, the docs are stored in the TYPO3.FLOW3 repo, and so 
they're sort-of relatable to a specific version of FLOW3, but as we write 
new chapters they often also apply to previous versions of FLOW3. How do we 
deal with that?

Does the domain model need some kind of metadata-attribute for the range of 
versions that a document applies to?