AgileApps Support Wiki Pre Release

Difference between revisions of "Template:Variables"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
====Variables and Their Usage====
These variables are defined for each skin in <tt>LocalSettings.php</tt>.<br>
These variables are defined for each skin in <tt>LocalSettings.php</tt>.<br>
They are case-insensitive.
They are case-insensitive.
<noinclude>__TOC__</noinclude>
====Global Variables====
Application names (because marketing can change them):
:{| border="1" cellpadding="5" cellspacing="1"
! align="left"|Variable !! Definition !! Value in Current Domain !! Usage
|-
| '''HD'''  || name of the "HelpDesk" application || {{HD}} || <tt><nowiki>{{HD}}</nowiki></tt>
|}
====Version Variables====
:{| border="1" cellpadding="5" cellspacing="1"
! align="left"|Variable !! align="left"|Value
|-
| <tt><nowiki>{{MySqlVersion}}</nowiki></tt> || align="center"| {{MySqlVersion}}
|-
| <tt><nowiki>{{VelocityVersion}}</nowiki></tt> || align="center"| {{VelocityVersion}}
|}
====Skin-Specific Variables====
:{| 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
Line 7: Line 25:
| '''Skin'''      || Abbreviated name || {{Skin}} || <tt><nowiki>{{#if {{Skin}}|name|...|...else...}}</nowiki></tt>
| '''Skin'''      || Abbreviated name || {{Skin}} || <tt><nowiki>{{#if {{Skin}}|name|...|...else...}}</nowiki></tt>
|-
|-
| '''Domain'''      || Used in the [[Template:platformURL|]platformURL] variable || {{Domain}} || Create platform links using <tt><nowiki>{{platformURL}}</nowiki></tt>, instead of <tt><nowiki>https://...</nowiki></tt>
| '''Domain'''      || Used in the [[Template:platformURL|platformURL]] template || {{Domain}} || Create platform links using <tt><nowiki>{{platformURL}}</nowiki></tt>, instead of <tt><nowiki>https://...</nowiki></tt>
|-
| '''platformURL'''  || [[Template:platformURL]]<br>Link used to access the platform || {{platformURL}} || <tt><nowiki>{{platformURL}}</nowiki></tt>
|-
|-
| '''BrandLabel'''      || Label used in GUI<br>(Eclipse, Outlook,...) || {{BrandLabel}} || <tt><nowiki>{{BrandLabel}}</nowiki></tt>
| '''BrandLabel'''      || Label used in plugin GUIs<br>(Eclipse, Outlook,...) || {{BrandLabel}} || <tt><nowiki>{{BrandLabel}}</nowiki></tt>
|-
|-
| '''EnterpriseBrand''' || Name of the platform || {{EnterpriseBrand}} || <tt><nowiki>{{EnterpriseBrand}}</nowiki></tt>
| '''EnterpriseBrand''' || Name of the platform || {{EnterpriseBrand}} || <tt><nowiki>{{EnterpriseBrand}}</nowiki></tt>
|-
| '''BrandName''' || [[Template:BrandName]]<br>Advertised brand || {{BrandName}} || <tt><nowiki>{{BrandName}}</nowiki></tt>
|-
|-
| '''TrainingLink'''    || A link for training sessions. || {{TrainingLink}}  || <tt><nowiki>{{#if {{TrainingLink}} | [{{TrainingLink}} Platform Training]}} </nowiki></tt>
| '''TrainingLink'''    || A link for training sessions. || {{TrainingLink}}  || <tt><nowiki>{{#if {{TrainingLink}} | [{{TrainingLink}} Platform Training]}} </nowiki></tt>
|-
| WhitepapersLink || colspan="4"|Future. Defined the same way as  "TrainingLink", so it is easy to change.
|-
|-
| colspan="4" style="border-bottom-style:none"| &nbsp;
| colspan="4" style="border-bottom-style:none"| &nbsp;
Line 20: Line 44:
| colspan="4" style="border-top-style:none" align="center"| '''Booleans'''
| colspan="4" style="border-top-style:none" align="center"| '''Booleans'''
|-
|-
| '''ShowWhitepapers''' || Show whitepapers? || {{ShowWhitepapers}} (empty=false) || <tt><nowiki>{{#if {{ShowWhitepapers}} | ...}}</nowiki></tt>
| '''ShowWhitepapers''' || Show whitepapers? || {{ShowWhitepapers}} (empty=false)<br>(Fixed branding) || <tt><nowiki>{{#if {{ShowWhitepapers}} | ...}}</nowiki></tt>
|-
|-
| '''ShowOutlookSync''' || Show info related to Outlook Sync & Email Edition Plugin? || {{ShowOutlookSync}} (empty=false) || <tt><nowiki>{{#if {{ShowOutlookSync}} | ...}} </nowiki></tt>
| '''ShowOutlookSync''' || Show info related to Outlook Sync & Email Edition Plugin? || {{ShowOutlookSync}} (empty=false) || <tt><nowiki>{{#if {{ShowOutlookSync}} | ...}} </nowiki></tt>
|-
|-
| '''ShowDevInfo''' || Show info for developers? || {{ShowDevInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowDevInfo}} | ...}}</nowiki></tt>
| '''ShowIsvInfo'''    || Show info only ISVs care about || {{ShowIsvInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowIsvInfo}} | ...}} </nowiki></tt>
|-
| '''ShowIsvInfo'''    || Show info only ISV care about? || {{ShowIsvInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowIsvInfo}} | ...}} </nowiki></tt>
|-
| '''ShowMspInfo'''    || Show info only MSPs care about? || {{ShowMspInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowMspInfo}} | ...}} </nowiki></tt>
|-
| colspan="4" style="border-bottom-style:none"| &nbsp;
 
|-
| colspan="4" style="border-top-style:none" align="center"| '''Boolean Inversions'''
|-
| '''HideWhitepapers''' || Hide whitepapers? || {{HideWhitepapers}} (empty=false) || <tt><nowiki>{{#if {{HideWhitepapers}} | ...}}</nowiki></tt>
|-
|-
| '''HideOutlookSync''' || Hide info related to Outlook sync? || {{HideOutlookSync}} (empty=false) || <tt><nowiki>{{#if {{HideOutlookSync}} | ...}} </nowiki></tt>
| '''ShowMspInfo'''     || Show info only MSPs care about || {{ShowMspInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowMspInfo}} | ...}} </nowiki></tt>
|-
|-
| '''HideDevInfo''' || Hide info for developers? || {{HideDevInfo}} (empty=false) || <tt><nowiki>{{#if {{HideDevInfo}} | ...}}</nowiki></tt>
| '''PlatformAdminInfo''' || Show tenant configuration  || {{PlatformAdminInfo}} (empty=false) || <tt><nowiki>{{#if {{PlatformAdminInfo}} | ...}} </nowiki></tt>
|-
|-
| '''HideIsvInfo'''    || Hide info only ISV care about? || {{HideIsvInfo}} (empty=false) || <tt><nowiki>{{#if {{HideIsvInfo}} | ...}} </nowiki></tt>
| '''ShowInstallInfo'''    || Show info for installers || {{ShowInstallInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowInstallInfo}} | ...}} </nowiki></tt>
|-
| '''HideMspInfo'''    || Hide info only MSPs care about? || {{HideMspInfo}} (empty=false) || <tt><nowiki>{{#if {{HideMspInfo}} | ...}} </nowiki></tt>
|}
|}
{{Note| In future, we can define a "WhitepapersLink", the same way we define "TrainingLink". It is then easy to change.}}


====Variable Combinations====
====Variable Combinations====


:Use this pattern to conditionalize information intended only for [[Service Provider]]s (both ISVs and MSPs):
:Use this pattern to conditionalize information intended for all [[Service Provider]]s (both ISVs and MSPs):
::{|
::{|
<pre>{{#if: {{ShowIsvInfo}} {{ShowMspInfo}} |
<pre>{{#if: {{ShowIsvInfo}} {{ShowMspInfo}} |
Line 58: Line 67:
|}
|}


:Use this pattern if it is necessary to distinguish information intended for ISVs only (even if it mentions MSPs) from information intended for MSPs only:
{{Note|Information intended for both is generally conditioned using <tt>ShowIsvInfo</tt>--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):
::{|
::{|
<pre>{{#if: {{ShowIsvInfo}} |
<pre>{{#if: {{ShowIsvInfo}} |
__ISV info (ISV DOMAIN) __
__ISV info (ISV DOMAIN) __
}}
 
{{#if: {{HideIsvInfo}} |
| <!-- HideIsvInfo -->
{{#if: {{ShowMspInfo}} |
{{#if: {{ShowMspInfo}} |
__MSP info (LJ DOMAIN)__
__MSP info (LJ DOMAIN)__
}}}}</pre>
}}}}</pre>
|}
|}

Latest revision as of 00:42, 17 April 2014

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

Global Variables

Application names (because marketing can change them):

Variable Definition Value in Current Domain Usage
HD name of the "HelpDesk" application ServiceDesk {{HD}}

Version Variables

Variable Value
{{MySqlVersion}} 5.5
{{VelocityVersion}} 1.7

Skin-Specific Variables

Variable Name Definition Value in Current Domain Usage
Skin Abbreviated name HD {{#if {{Skin}}|name|...|...else...}}
Domain Used in the platformURL template {yourDomain} Create platform links using {{platformURL}}, instead of https://...
platformURL Template:platformURL
Link used to access the platform		 https://{yourDomain}/networking {{platformURL}}
BrandLabel Label used in plugin GUIs
(Eclipse, Outlook,...)		 LongJump {{BrandLabel}}
EnterpriseBrand Name of the platform AgileApps Cloud platform {{EnterpriseBrand}}
BrandName Template:BrandName
Advertised brand		 AgileApps Cloud {{BrandName}}
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)
(Fixed branding)		 {{#if {{ShowWhitepapers}} | ...}}
ShowOutlookSync Show info related to Outlook Sync & Email Edition Plugin? (empty=false) {{#if {{ShowOutlookSync}} | ...}}
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)__
}}}}
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=Template:Variables&oldid=13345"