Versioning OXpedia articles
OX6 and AppSuite code is improving continuously. Therefore, APIs and SPIs are bound to change. Changes are publicized cautiously with each now release, depending on the maturity of the module and, depending on that, the stability of the existing documentation.
To ensure you know which feature is enabled with which version, here is an explanation on how the versioning of our documentation works:
For the reader
If you encounter an article link which does not have a version number, this goes to the lastest version of the article. When linking articles, you should usually avoid using a version number (unless you are pointing to a specific version, of course), thereby always linking the latest article.
- In case there were previous versions, the current article will link the one before it in one of the first lines.
- If there is none, you are safe to assume there have been no changes.
Note: In case there is only one article and it never had a precedent, the article title will not have a version number yet. Otherwise, the article without one will be a redirect to the latest version.
For the writer
- If you create a new article and just want to get the information out, feel free to avoid using version numbers at all. Well clean up after you if necessary.
- If you create an article that describes an API, SPI or something else that might be changed or improved...
- create an article with a version number in the scheme $articleName_7.0.2, where 7.0.2 is the version that will introduce this scheme.
- create another article without a version number that is a redirect the the latest version.
- If you want update an article
- copy the contents to a new page with a new version number
- update the text with your changes
- change the redirect in the main page, the one without a version number, to the latest one.
For Unix/Linux users: This behaviour is modelled similar to how libraries usually work: Several versions can exist in their own folder, the one you are currently using is the one without a version identifier, which is a symlink to one of the versioned ones (the latest, usually).