Difference between revisions of "Template:Skin-specific Variables"

Latest revision as of 23:59, 2 August 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 (global)	Template:Version	`{{Version}}`
Skin	Abbreviated name	LJ	`{{#if {{Skin}}\|name\|...\|...else...}}`
Domain	Used in the platformURL variable	na.longjump.com	Create platform links using `{{platformURL}}`, instead of `https://...`
BrandLabel	Label used in GUI (Eclipse, Outlook,...)	LongJump	`{{BrandLabel}}`
EnterpriseBrand	Name of the platform	LongJump Platform	`{{EnterpriseBrand}}`
TrainingLink	A link for training sessions.	http://www.longjump.com/index.php?option=com_eventlist&view=eventlist&Itemid=178	`{{#if {{TrainingLink}} \| [{{TrainingLink}} Platform Training]}}`
WhitepapersLink	Future. Defined the same way as "TrainingLink", so it is easy to change.

Booleans
ShowWhitepapers	Show whitepapers?	true (empty=false) (Fixed branding)	`{{#if {{ShowWhitepapers}} \| ...}}`
ShowOutlookSync	Show info related to Outlook Sync & Email Edition Plugin?	true (empty=false)	`{{#if {{ShowOutlookSync}} \| ...}}`
ShowIsvInfo	Show info only ISVs care about	true (empty=false)	`{{#if {{ShowIsvInfo}} \| ...}}`
ShowMspInfo	Show info only MSPs care about	true (empty=false)	`{{#if {{ShowMspInfo}} \| ...}}`
PlatformAdminInfo	Show tenant configuration	(empty=false)	`{{#if {{PlatformAdminInfo}} \| ...}}`
ShowInstallInfo	Show info for installers	(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)__
}}

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)__
}}}}

@@ Line 4: / Line 4: @@
 :{| border="1" cellpadding="5" cellspacing="1"
 ! align="left"|Variable Name !! Definition !! align="left"| Value in Current Domain !! align="left"|Usage
+|-
+| '''Version'''   || Platform version identifer (global) || {{Version}} || <tt><nowiki>{{Version}}</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>
 |-
 | '''BrandLabel'''      || Label used in GUI<br>(Eclipse, Outlook,...) || {{BrandLabel}} || <tt><nowiki>{{BrandLabel}}</nowiki></tt>
@@ Line 12: / Line 16: @@
 |-
 | '''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;
@@ Line 18: / Line 24: @@
 | colspan="4" style="border-top-style:none" align="center"| '''Booleans'''
 |-
-| '''ShowWhitepapers''' || Show whitepapers?<br>(All say "LongJump".) || {{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>
 |-
-| '''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'''
+| '''ShowMspInfo'''     || Show info only MSPs care about || {{ShowMspInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowMspInfo}} | ...}} </nowiki></tt>
 |-
-| '''HideWhitepapers''' || Hide whitepapers?<br>(All say "LongJump".) || {{HideWhitepapers}} (empty=false) || <tt><nowiki>{{#if {{HideWhitepapers}} | ...}}</nowiki></tt>
+| '''PlatformAdminInfo''' || Show tenant configuration  || {{PlatformAdminInfo}} (empty=false) || <tt><nowiki>{{#if {{PlatformAdminInfo}} | ...}} </nowiki></tt>
 |-
-| '''HideOutlookSync''' || Hide info related to Outlook sync? || {{HideOutlookSync}} (empty=false) || <tt><nowiki>{{#if {{HideOutlookSync}} | ...}} </nowiki></tt>
+| '''ShowInstallInfo'''     || Show info for installers || {{ShowInstallInfo}} (empty=false) || <tt><nowiki>{{#if {{ShowInstallInfo}} | ...}} </nowiki></tt>
-|-
-| '''HideDevInfo''' || Hide info for developers? || {{HideDevInfo}} (empty=false) || <tt><nowiki>{{#if {{HideDevInfo}} | ...}}</nowiki></tt>
-|-
-| '''HideIsvInfo'''     || Hide info only ISV care about? || {{HideIsvInfo}} (empty=false) || <tt><nowiki>{{#if {{HideIsvInfo}} | ...}} </nowiki></tt>
-|-
-| '''HideMspInfo'''     || Hide info only MSPs care about? || {{HideMspInfo}} (empty=false) || <tt><nowiki>{{#if {{HideMspInfo}} | ...}} </nowiki></tt>
 |}
-{{Note| We could also define a "WhitepapersLink", the same way we specify "TrainingLink". We could then use that link, if it exists, in preference to the standard [[Template:DOCHOST]] link.}}
 ====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}} |
@@ Line 56: / Line 47: @@
 |}
-: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}} |
 __ISV info (ISV DOMAIN) __
-}}
-{{#if: {{HideIsvInfo}} |
+| <!-- HideIsvInfo -->
 {{#if: {{ShowMspInfo}} |
 __MSP info (LJ DOMAIN)__
 }}}}</pre>
 |}

Search

where to start

learn more

Tools

Personal tools

Difference between revisions of "Template:Skin-specific Variables"

Latest revision as of 23:59, 2 August 2012

Variables and Their Usage

Variable Combinations