Difference between revisions of "Buttons"

From Tweeki
Jump to: navigation, search
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Components]] __FORCETOC__
 
[[Category:Components]] __FORCETOC__
−
With tweeki it is very easy to create any button you would like to have. By using smart defaults the markup can be very reduced.
+
With Tweeki it is very easy to create any button you would like to have. By using smart defaults the markup can be very reduced.
 +
 
 +
<div class="alert alert-info" role="alert"><strong>Caveat:</strong> This feature bypasses MediaWiki's default link handling. This might have security implications. You should only allow editing to people you trust! Also features like 'Links to this site' will not work for button links.</div>
 +
 
 
== Standard Buttons ==
 
== Standard Buttons ==
−
{| class=wikitable
+
{| class="table table-bordered"
 
! Markup !! Result
 
! Markup !! Result
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>Simple Button</button>
+
<btn>Simple Button</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>Simple Button</button>
+
<btn>Simple Button</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button size="large">Large Button</button>
+
<btn size="lg">Large Button</btn>
−
<button size="small">Small Button</button>
+
<btn size="sm">Small Button</btn>
−
<button size="mini">Mini Button</button>
 
 
</pre>
 
</pre>
 
|
 
|
−
<div class="btn-toolbar"><button size="large">Large Button</button>
+
<btn size="lg">Large Button</btn>
−
<button size="small">Small Button</button>
+
<btn size="sm">Small Button</btn>
−
<button size="mini">Mini Button</button></div>
 
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Grouped
 
Grouped
 
Buttons
 
Buttons
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
 
Grouped
 
Grouped
 
Buttons
 
Buttons
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Button
 
Button
  
 
Tool
 
Tool
 
Bar
 
Bar
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
 
Button
 
Button
  
 
Tool
 
Tool
 
Bar
 
Bar
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button class="btn-primary">
+
<btn class="btn-primary">
 
Classy
 
Classy
 
Buttons
 
Buttons
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button class="btn-primary">
+
<btn class="btn-primary">
 
Classy
 
Classy
 
Buttons
 
Buttons
−
</button>
+
</btn>
 +
|-
 +
|
 +
<pre>
 +
<btn class="">
 +
Button without any class
 +
</btn>
 +
</pre>
 +
|
 +
<btn class="">
 +
Button without any class
 +
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Classy||btn-primary
 
Classy||btn-primary
 
Non-classy
 
Non-classy
 
Very Classy||btn-success
 
Very Classy||btn-success
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
 
Classy||btn-primary
 
Classy||btn-primary
 
Non-classy
 
Non-classy
 
Very Classy||btn-success
 
Very Classy||btn-success
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Standard Button
 
Standard Button
−
Internal Target|Some Page Title
+
Some Page Title|Internal Target
−
External Target|http://some.where
+
http://some.where|External Target
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
 
Standard Button
 
Standard Button
−
Internal Target|Some Page Title
+
Some Page Title|Internal Target
−
External Target|http://some.where
+
http://some.where|External Target
−
</button>
+
</btn>
 
|}
 
|}
  
 
== Dropdown Buttons ==
 
== Dropdown Buttons ==
  
−
{| class=wikitable
+
{| class="table table-bordered"
 
! Markup !! Result
 
! Markup !! Result
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Dropdown-Menu
 
Dropdown-Menu
 
* Some Menu Item
 
* Some Menu Item
−
** Submenu
 
 
*
 
*
 +
*: Some Heading
 
* Some Other Menu Item
 
* Some Other Menu Item
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
 
Dropdown-Menu
 
Dropdown-Menu
 
* Some Menu Item
 
* Some Menu Item
−
** Submenu
 
 
*
 
*
 +
*: Some Heading
 
* Some Other Menu Item
 
* Some Other Menu Item
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
−
Split Dropdown|Target
+
Target|Split Dropdown
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button>
+
<btn>
−
Split Dropdown|Target
+
Target|Split Dropdown
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button class="">
+
<btn class="">
 
Non-Button Dropdown
 
Non-Button Dropdown
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button class="">
+
<btn class="">
 
Non-Button Dropdown
 
Non-Button Dropdown
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button>
+
<btn>
 
Semantic Dropdown
 
Semantic Dropdown
 
* {{#ask:[[Category:Components]]}}
 
* {{#ask:[[Category:Components]]}}
−
</button>
+
</btn>
 
</pre>
 
</pre>
 +
<small>'''Note:''' this only works with the [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic MediaWiki] extension installed.
 
|
 
|
−
<button>
+
<btn>
 
Semantic Dropdown
 
Semantic Dropdown
 
* {{#ask:[[Category:Components]]}}
 
* {{#ask:[[Category:Components]]}}
−
</button>
+
</btn>
 
|}
 
|}
  
 
== Wrappers ==
 
== Wrappers ==
  
−
{| class=wikitable
+
{| class="table table-bordered"
 
! Markup !! Result
 
! Markup !! Result
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button wrapperclass="btn-group dropup">
+
<btn wrapperclass="btn-group dropup">
 
Dropup
 
Dropup
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button wrapperclass="btn-group dropup">
+
<btn wrapperclass="btn-group dropup">
 
Dropup
 
Dropup
 
* Some Menu Item
 
* Some Menu Item
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button wrapperclass="btn-group btn-group-vertical">
+
<btn wrapperclass="btn-group-vertical">
 
Explicit
 
Explicit
 
Wrapper
 
Wrapper
 
Setting
 
Setting
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button wrapperclass="btn-group btn-group-vertical">
+
<btn wrapperclass="btn-group-vertical">
 
Explicit
 
Explicit
 
Wrapper
 
Wrapper
 
Setting
 
Setting
−
</button>
+
</btn>
 
|-
 
|-
 
|
 
|
 
<pre>
 
<pre>
−
<button wrapper="">
+
<btn wrapper="">
 
Explicit
 
Explicit
 
Wrapper
 
Wrapper
 
Unsetting
 
Unsetting
−
</button>
+
</btn>
 
</pre>
 
</pre>
 
|
 
|
−
<button wrapper="">
+
<btn wrapper="">
 
Explicit
 
Explicit
 
Wrapper
 
Wrapper
 
Unsetting
 
Unsetting
−
</button>
+
</btn>
 +
|}
 +
 
 +
== Styling ==
 +
 
 +
{| class="table table-bordered"
 +
! Markup !! Result
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
Target|<i>Italic Tag</i>
 +
</btn>
 +
</pre>
 +
|
 +
<btn>
 +
Target|<i>Italic Tag</i>
 +
</btn>
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
Target|''Italic Wiki Markup''
 +
</btn>
 +
</pre>
 +
|
 +
<btn>
 +
Target|''Italic Wiki Markup''
 +
</btn>
 +
|-
 +
|
 +
<pre>
 +
''<btn>
 +
Surrounding Italic Wiki Markup
 +
</btn>''
 +
</pre>
 +
|
 +
''<btn>
 +
Surrounding Italic Wiki Markup
 +
</btn>''
 +
|}
 +
 
 +
== Icons ==
 +
 
 +
{| class="table table-bordered"
 +
! Markup !! Result
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
Target|<span class="fa fa-cog"></span> icon with span
 +
</btn>
 +
</pre>
 +
|
 +
<btn>
 +
Target|<span class="fa fa-cog"></span> icon with span
 +
</btn>
 +
|-
 +
|
 +
<pre>
 +
<btn icon="cog">
 +
icon attribute
 +
</btn>
 +
</pre>
 +
|
 +
<btn icon="cog">
 +
icon attribute
 +
</btn>
 +
|}
 +
 
 +
== Parsing ==
 +
{| class="table table-bordered"
 +
! Markup !! Result
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
{{fullurl:{{PAGENAME}}}}|{{ucfirst:magic words}}
 +
</btn>
 +
</pre>
 +
|
 +
<btn>
 +
{{fullurl:{{PAGENAME}}}}|{{ucfirst:magic words}}
 +
</btn>
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
mainpage
 +
</btn>
 +
</pre>
 +
<small><b>Info</b>: if a system message by that name exists, the text will be replaced by it's content</small>
 +
|
 +
<btn>
 +
mainpage
 +
</btn>
 +
|-
 +
|
 +
<pre>
 +
<btn>
 +
&&shy;shy;mainpage
 +
</btn>
 +
</pre>
 +
<small><b>Info</b>: you can avoid this behaviour by adding an HTML entity that doesn't consume screen space like <code>&amp;shy;</code>. It will be invisible in the title and filtered out for the URL.<br>Alternatively, create a new message and use that.</small>
 +
|
 +
<btn>
 +
&shy;mainpage
 +
</btn>
 
|}
 
|}
  

Latest revision as of 12:04, 30 December 2021

With Tweeki it is very easy to create any button you would like to have. By using smart defaults the markup can be very reduced.

Standard Buttons

Markup Result 
<btn>Simple Button</btn>
Simple Button
<btn size="lg">Large Button</btn>
<btn size="sm">Small Button</btn>
Large Button
Small Button
<btn>
Grouped
Buttons
</btn>
GroupedButtons
<btn>
Button

Tool
Bar
</btn>
Button
ToolBar
<btn class="btn-primary">
Classy
Buttons
</btn>
ClassyButtons
<btn class="">
Button without any class
</btn>
Button without any class
<btn>
Classy||btn-primary
Non-classy
Very Classy||btn-success
</btn>
ClassyNon-classyVery Classy
<btn>
Standard Button
Some Page Title|Internal Target
http://some.where|External Target
</btn>
Standard ButtonInternal TargetExternal Target

Dropdown Buttons

Markup Result 
<btn>
Dropdown-Menu
* Some Menu Item
*
*: Some Heading
* Some Other Menu Item
</btn>
Dropdown-Menu
Some Menu Item
Some Heading
Some Other Menu Item
<btn>
Target|Split Dropdown
* Some Menu Item
</btn>
Split DropdownToggle Dropdown
Some Menu Item
<btn class="">
Non-Button Dropdown
* Some Menu Item
</btn>
Non-Button Dropdown
Some Menu Item
<btn>
Semantic Dropdown
* {{#ask:[[Category:Components]]}}
</btn>

Note: this only works with the Semantic MediaWiki extension installed.

Semantic Dropdown
AccordionsButtonsCarouselFormsModalsNavigationTabsTooltips

Wrappers

Markup Result 
<btn wrapperclass="btn-group dropup">
Dropup
* Some Menu Item
</btn>
Dropup
Some Menu Item
<btn wrapperclass="btn-group-vertical">
Explicit
Wrapper
Setting
</btn>
ExplicitWrapperSetting
<btn wrapper="">
Explicit
Wrapper
Unsetting
</btn>

ExplicitWrapperUnsetting

Styling

Markup Result 
<btn>
Target|<i>Italic Tag</i>
</btn>
Italic Tag
<btn>
Target|''Italic Wiki Markup''
</btn>
Italic Wiki Markup
''<btn>
Surrounding Italic Wiki Markup
</btn>''
Surrounding Italic Wiki Markup

Icons

Markup Result 
<btn>
Target|<span class="fa fa-cog"></span> icon with span
</btn>
icon with span
<btn icon="cog">
icon attribute
</btn>
icon attribute

Parsing

Markup Result 
<btn>
{{fullurl:{{PAGENAME}}}}|{{ucfirst:magic words}}
</btn>
Magic words
<btn>
mainpage
</btn>

Info: if a system message by that name exists, the text will be replaced by it's content

Welcome
<btn>
&­shy;mainpage
</btn>

Info: you can avoid this behaviour by adding an HTML entity that doesn't consume screen space like &shy;. It will be invisible in the title and filtered out for the URL.
Alternatively, create a new message and use that.

­mainpage

Specifications

The general structure for the code of a single button is target|text|class, where text and class are optional. If text is omitted it is assumed to be the same as target. target and text are parsed after the following algorithm.

  1. Check for semantic queries.
  2. If there is an existing or default interface message with that name, use the content of that message instead.
  3. Parse it.
  4. If it is a valid URL (beginning with http:// or other URL protocol), the link will point to that URL.
  5. Else, it will be treated as a wikilink.
Retrieved from "https://tweeki.kollabor.at/w/index.php?title=Buttons&oldid=857"