Feature #861: === Website & Examples ===
don't use version-dependent URLs in the online docs
|Status:||Rejected||Start date:||17 Jun 2015|
#1 Updated by wuttke about 4 years ago
Currently, the URL is http://apps.jcns.fz-juelich.de/src/BornAgain/BornAgainManual-<VERSION>.pdf. It won't be possible to keep all internal and external links updated when VERSION changes.
#2 Updated by wuttke over 3 years ago
- Subject changed from Persistent (version-independent) URL for manual to don't use version-dependent URLs in the online docs
- Parent task changed from #966 to #861
Currently, our Drupal pages contain links to version-dependent file names like BornAgainManual-1.4.0.pdf or BornAgain-1.4.0-macosx64-10.9+.dmg.
We could in principle replace these version-dependent URLs by symlinks, or use a forwarding mechanism in httpd.conf.
On closer investigation, I found none of these solutions convincing.
Instead, we should modify the Drupal pages: instead of providing direct links to the manual or to the installer packages, we should direct the user to the src/ directory.
This is slightly more effort for a first-time user. But it has the advantage that users will learn about the src/ directory. Ideally then, at the next release they will return there to download the newest files.
#4 Updated by wuttke about 3 years ago
- Status changed from Rfc to Rejected
Much simpler solution is already implemented: use a few variables in Drupal.
To set them: Drupal > Admin > Structure > Token-custom > man_version, version_long, version_short
To use them: e.g. [custom:bornagain-manual-version] within a URL