Template:Link - Revision history

Wf: transfered by WikiBackup wikiTask at 2017-11-05T18:05:34Z

2017-11-05T18:05:35Z

transfered by WikiBackup wikiTask at 2017-11-05T18:05:34Z

Wf: transfered by WikiBackup wikiTask at 2015-12-28T13:36:55Z

2015-12-28T13:37:02Z

transfered by WikiBackup wikiTask at 2015-12-28T13:36:55Z

Wf: transfered by WikiBackup wikiTask at 2015-11-05T19:45:54Z

2015-11-05T19:45:56Z

transfered by WikiBackup wikiTask at 2015-11-05T19:45:54Z

Wf: Created page with " == template purpose == This is a Template for internal and external Links in WikiSon notatio..."

2015-10-23T06:02:25Z

Created page with "<noinclude>  == template purpose == This is a Template for internal and external Links in WikiSon notatio..."

New page

<noinclude>

== template purpose ==
This is a Template for internal and external Links in WikiSon notation.
=== Motivation ===
In Mediawiki there are at least five different ways to use a link - we'd like to hide this complexity and add new functionality:
# <pre>[[Main Page]]</pre>[[Main Page]] - internal link with no text
# <pre>[[Main Page|Start Page]]</pre>[[Main Page|Start Page]] - internal link with text
# <pre>[http://partner.bitplan.com] </pre>[http://partner.bitplan.com] - external link as footnote
# <pre>[http://partner.bitplan.com BITPlan partner site] </pre>[http://partner.bitplan.com BITPlan partner site] - external link with text
# <pre>http://partner.bitplan.com </pre>http://partner.bitplan.com - automatic external link

== WikiSon Link ==
=== Motivation ===
The Concept behind a link is
<uml>
Class Link {
target
title
}
' BITPlan Corporate identity skin params
' Copyright (c) 2015 BITPlan GmbH
' see http://wiki.bitplan.com/PlantUmlSkinParams#BITPlanCI
' skinparams generated by com.bitplan.restmodelmanager
hide Circle
skinparam note{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Technical
}

skinparam component{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Arial
}

skinparam package{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Arial
}

skinparam usecase{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Arial
}

skinparam activity{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Arial
}

skinparam classAttribute{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Technical
}

skinparam interface{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Arial
}

skinparam class{
BackGroundColor #FFFFFF
FontSize 14
ArrowColor #FF8000
BorderColor #FF8000
FontColor black
FontName Technical
}
</uml>
This calls for the WikiSon notation
<pre>
{{Link
|target=sometarget
|text=sometext
}}
</pre>
=== Link as WikiSon ===
Using the WikiSon Concept approach the Link Concept is represented via
the Wiki [[:Category:Link]]<br>
Especially there is a [[List of Links]] page available.

=== Importance ===
this is a fundamental concept should not be broken. Therefore
{{Fixme|todo=This template needs to be protected soon|done=true}}
{{Fixme|todo=This template needs to be distributed in the smartMediaWiki network of wikis|done=false}}

=== Examples ===
<pre>
{{Link}}
</pre>
internal default link to Main Page
{{Link}}
<pre>
{{Link|target=Main Page}}
</pre>
internal link to Main Page
{{Link|target=Main Page}}
<pre>
{{Link|target=Main Page|title=Main Page}}
</pre>
internal link to Main Page with title
{{Link|target=Main Page|title=Main Page}}

<pre>
{{Link|target=http://partner.bitplan.com}}
</pre>
external link
{{Link|target=http://partner.bitplan.com}}

<pre>
{{Link|target=http://partner.bitplan.com|title=BITPlan Partner wiki}}
</pre>
external link with title
{{Link|target=http://partner.bitplan.com|title=BITPlan Partner wiki}}

=== implementation ===
==== Prerquisite ====
LocalSettings.php needs to have the StringFunctions enabled:
<source lang='php'>
# WF 2015-01-20
# allow string functions
$wgPFEnableStringFunctions=true;
</source>
==== Template source ====
The complexity of this template macro needs to be hidden
===== original Link Template =====
<pre>
{{#set:Link target={{{target|}}}
|Link title={{{title|}}}
}}{{#ifeq:
{{#sub:{{{target|}}}|0|4}}
| http | {{#set:Link targetUrl={{{target|}}}}}{{#if: {{{title|}}}
| [{{{target|http://www.smartMediaWiki.com}}} {{{title}}}]
| [{{{target|http://www.smartMediaWiki.com}}}]
}}| {{#set:Link targetPage={{{target|}}}}}{{#if: {{{title|}}}
| [[{{{target|Main Page}}}|{{{title}}}]]
| [[{{{target|Main Page}}}]]
}}}}[[Category:Link]]
</pre>
===== pretty printed Template macro =====
this version would unfortunately create unwanted newlines in the macro result
<source lang='html4strict'>

{{#set:Link target={{{target|}}}
|Link title={{{title|}}}
}}

{{#ifeq:
{{#sub:{{{target|}}}|0|4}}

| http

| 
{{#set:Link targetUrl={{{target|}}}}}


{{#if: {{{title|}}}
| [{{{target|http://www.smartMediaWiki.com}}} {{{title}}}]
| [{{{target|http://www.smartMediaWiki.com}}}]
}}

| 
{{#set:Link targetPage={{{target|}}}}}


{{#if: {{{title|}}}
| [[{{{target|Main Page}}}|{{{title}}}]]
| [[{{{target|Main Page}}}]]
}}
}}

[[Category:Link]]
</source>

==== How the Link Macro works ====
The Link Macro checks whether the link is external or internal and displays the correct version. It sets the Link Concept's attributes by setting the correspond Semantic Media Wiki properties.
it uses the following helper funcitons:

* Substring: https://www.mediawiki.org/wiki/Extension:StringFunctions/en#.23sub:
* #ifeq: https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions/en#.23ifeq
* #if: https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions/en#.23if
* #set: https://semantic-mediawiki.org/wiki/Help:Setting_values
===== Substring =====
<pre>
{{#sub:string|start|length}}

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

Example: {{#sub:Icecream|3}} returns cream.

{{#sub:Icecream|0|3}} returns Ice.
</pre>

===== if exists and non empty =====
<pre>
{{#if: test string | value if test string is not empty | value if test string is empty (or only white space) }}
</pre>

===== if equals =====
<pre>
{{#ifeq: string 1 | string 2 | value if identical | value if different }}
</pre>
===== setting Semantic values =====
<pre>
{{#set:Has population=2,234,105
|Located in country=France
|Has mayor=Bertrand Delanoë
}}
</pre>

=== SMW PageSchema use ===
==== generated version of this template ====
<pre>
< noinclude>
Dies ist die Vorlage „Link“.
Sie sollte im folgenden Format genutzt werden:
< pre>
{{Link
|target=
|title=
}}
</ pre>
Klick auf „Bearbeiten“, um den Quelltext der Vorlage anzusehen.
</ noinclude>< includeonly>{| class="wikitable"
! target
| [[Link_target::{{{target|}}}]]
|-
! title
| [[Link_title::{{{title|}}}]]
...
|}

[[Kategorie:Link]]
</ includeonly>
</pre>
[[Category:Template]]</noinclude><includeonly>{{#set:Link target={{{target|}}}
|Link title={{{title|}}}
}}{{#ifeq:
{{#sub:{{{target|}}}|0|4}}
| http | {{#set:Link targetUrl={{{target|}}}}}{{#if: {{{title|}}}
| [{{{target|http://www.smartMediaWiki.com}}} {{{title}}}]
| [{{{target|http://www.smartMediaWiki.com}}}]
}}| {{#set:Link targetPage={{{target|}}}}}{{#if: {{{title|}}}
| [[{{{target|Main Page}}}|{{{title}}}]]
| [[{{{target|Main Page}}}]]
}}}}</includeonly>

@@ Line 1: / Line 1: @@
-<noinclude>
+<noinclude><!-- THIS FILE IS PROTECTED - smartGENERATOR WILL NOT OVERWRITE IT -->{{TemplateSequence
-<!-- THIS FILE IS PROTECTED - smartGENERATOR WILL NOT OVERWRITE IT -->
+|prev=Template:Language
-{{PageSequence
+|next=Template:PageSequence
 }}
 == template purpose ==
@@ Line 243: / Line 239: @@
 </pre>
-=== SMW PageSchema use ===
+[[Categorie:Link]]
 [[Category:Template]]</noinclude><includeonly>{{#set:Link target={{{target|}}}
 |Link title={{{title|}}}

@@ Line 1: / Line 1: @@
 <noinclude><!-- THIS FILE IS PROTECTED - smartGENERATOR WILL NOT OVERWRITE IT -->{{TemplateSequence
-|prev=Template:Language
+|prev=Template:Languagelink
 |next=Template:PageSequence
 }}
@@ Line 102: / Line 102: @@
 {{Link
 |target=sometarget
-|text=sometext
+|title=sometitle
 }}
 </pre>
 === Link as WikiSon ===
 Using the WikiSon Concept approach the Link Concept is represented via
@@ Line 110: / Line 111: @@
 Especially there is a [[List of Links]] page available.
-=== Importance ===
+Properties set:
-this is a fundamental concept should not be broken. Therefore
+* {{Link|target=Property:Link targetUrl}}
 === Examples ===
@@ Line 145: / Line 144: @@
 === implementation ===
-==== Prerquisite ====
+==== Prerequisite ====
 LocalSettings.php needs to have the StringFunctions enabled:
 <source lang='php'>
@@ Line 152: / Line 151: @@
 $wgPFEnableStringFunctions=true;
 </source>
 ==== Template source ====
 The complexity of this template macro needs to be hidden
@@ Line 238: / Line 238: @@
 }}
 </pre>
+=== Properties set ===
 [[Categorie:Link]]
 [[Category:Template]]</noinclude><includeonly>{{#set:Link target={{{target|}}}