Currently a package will either implement versioning or it will not.
If a project implements versioning, the top level of the project there would be version folders.
Normal layout looks like this:
- package-folder - FPM.ftd - index.ftd - foo.ftd
- package-folder - FPM.ftd - v1/ - index.ftd - foo.ftd - v2/ - index.ftd
foo.ftd
does not exist in v2
folder, since it has not been edited in v2.fpm.package
fpm.package
includes one more field versioned
of boolean type with default value as false. Set this field to true to enable versioning.-- fpm.package: <package-name> versioned: true
foo.com/v1/
(corresponding to index.ftd), foo.com/v1/foo/,
foo.com/v2/and
foo.com/v2/foo/(even though there is no
foo.ftdin
v2` folder).Further the latest version’s content would be reflected on top level, so we have foo.com/
and foo.com/foo/
.
Top level URLs would use latest version as the canonical URL. NOT SURE ABOUT IT.
base
URLAll urls in markdown etc should use only be partial urls, so eg if index.ftd
is talking about foo.com/foo/
it should link to it using foo/
.
If the project was foo.com/bar
, the base URL is /bar/
, and full URLs of the files mentioned above would be foo.com/bar/v1/
, foo.com/bar/v1/foo/
and so on, so when linking we index.ftd
will continue to use foo/
as path, and base URL would be set to /bar/v1/
etc, based on which file being built.
foo.com/v2/
not foo.com/
even though the two have same content.ftd.toc-item list fpm.versions
v1
, v2
, and so on. The link will point to the current document’s URL in that version. If the current document is not present in that version the link is not set.