fpm
Variables
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This variable is set to true when the browser is mobile like. We detect mobile
or desktop based on browser width. fpm.mobile-breakpoint
can be used to
customize when we switch from mobile to desktop.
fpm.mobile
automatically changes when browser resizes.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This is the width below which we consider show the mobile view.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This variable tells you the language of current package if provided in FPM.ftd file. This is generally the case when translation is enabled.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
It gives the home url of the package which basically is //<package.name>
.
fpm.translation-status-url
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
In case of translation package, the value is //<package.name>/FPM/translation-status/
. Do not use this variable if translation is not enabled for this project.
Type:
fpm.language-toc-item list
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
It is a list of record language-toc-item
. This record has following structure
language-toc-item
-- record language-toc-item:
caption title:
string url:
-- record language-toc-item:
caption title:
string url:
It contains the list of all the available languages.
fpm.current-document-last-modified-on
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives the last modified on
in datetime format for the current document. It fetches it from the .history snapshots (which is available only after running fpm sync
)
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives the last modified on
in datetime format for the current package. It fetches it from the .history snapshots (which is available only after running fpm sync
)
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives the current package name. Eg fpm.dev
.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives the total number of documents available in current package.
In case of translation package, it gives
<total number of documents available in current package> / <total number of documents available in original package>
Note: It fetches it from .history snapshot latest record. So if the package is
never synced it gives incorrect value.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This show the difference in document on out of date translation state. Only to be used with fpm.translation-status
is Outdated
.
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
When package is the translation package, it has following value for different
states:
- Missing
- NeverMarked
- UptoDate
- Outdated
fpm.is-translation-package
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives true if the package is the translation package, false otherwise
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.
This gives true if the package has translations available, false otherwise
This variable is dynamic, it can change after page load.
This variable is readonly, do not try to modify it.