AgileApps Support Wiki Pre Release

Difference between revisions of "Template:Variables"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 4: Line 4:
:{| border="1" cellpadding="5" cellspacing="1"  
:{| border="1" cellpadding="5" cellspacing="1"  
! align="left"|Variable Name !! Definition !! align="left"| Value in Current Domain !! align="left"|Usage
! align="left"|Variable Name !! Definition !! align="left"| Value in Current Domain !! align="left"|Usage
|-
| '''Version'''  || Platform version identifer || {{Version}} || <tt><nowiki>{{Version}}</nowiki></tt>
|-
|-
| '''Skin'''      || Abbreviated name || {{Skin}} || <tt><nowiki>{{#if {{Skin}}|name|...|...else...}}</nowiki></tt>
| '''Skin'''      || Abbreviated name || {{Skin}} || <tt><nowiki>{{#if {{Skin}}|name|...|...else...}}</nowiki></tt>

Revision as of 19:03, 6 June 2012

Variables and Their Usage

These variables are defined for each skin in LocalSettings.php.
They are case-insensitive.

Variable Name Definition Value in Current Domain Usage
Version Platform version identifer Template:Version {{Version}}
Skin Abbreviated name HD {{#if {{Skin}}|name|...|...else...}}
Domain Used in the platformURL variable {yourDomain} Create platform links using {{platformURL}}, instead of https://...
BrandLabel Label used in GUI
(Eclipse, Outlook,...)
LongJump {{BrandLabel}}
EnterpriseBrand Name of the platform AgileApps Cloud platform {{EnterpriseBrand}}
TrainingLink A link for training sessions. {{#if {{TrainingLink}} | [{{TrainingLink}} Platform Training]}}
WhitepapersLink Future. Defined the same way as "TrainingLink", so it is easy to change.
 
Booleans
ShowWhitepapers Show whitepapers? (empty=false) {{#if {{ShowWhitepapers}} | ...}}
ShowOutlookSync Show info related to Outlook Sync & Email Edition Plugin? (empty=false) {{#if {{ShowOutlookSync}} | ...}}
ShowDevInfo Show info for developers? Template:ShowDevInfo (empty=false) {{#if {{ShowDevInfo}} | ...}}
ShowIsvInfo Show info only ISVs care about (empty=false) {{#if {{ShowIsvInfo}} | ...}}
ShowMspInfo Show info only MSPs care about (empty=false) {{#if {{ShowMspInfo}} | ...}}
PlatformAdminInfo Show tenant configuration true (empty=false) {{#if {{PlatformAdminInfo}} | ...}}
ShowInstallInfo Show info for installers true (empty=false) {{#if {{ShowInstallInfo}} | ...}}

Variable Combinations

Use this pattern to conditionalize information intended for all Service Providers (both ISVs and MSPs):
{{#if: {{ShowIsvInfo}} {{ShowMspInfo}} |
__Info for all Service Providers (LJ and ISV domains)__
}}

Notepad.png

Note: Information intended for both is generally conditioned using ShowIsvInfo--whether or not that was a wise choice remains TBD. So the combination above isn't strictly necessary.

Use this pattern if it is necessary to distinguish information intended for ISVs (which may mention MSPs) from information intended for MSPs, in Wiki versions that do not include ISV info (e.g. Relationals):
{{#if: {{ShowIsvInfo}} |
__ISV info (ISV DOMAIN) __

| <!-- HideIsvInfo -->
{{#if: {{ShowMspInfo}} |
__MSP info (LJ DOMAIN)__
}}}}