(added feature to documentation) |
(updatd documentation) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{documentation}} | {{documentation}} | ||
==Usage== | ==Usage== | ||
{{t|link | {{t|link attributes}} applies [[Help:CSS|CSS]] style and/or HTML attributes to a link. It accepts six parameters: | ||
# the page being linked | |||
# the style of the link - optional | |||
# the style of the link if the page being linked does not exist - optional - only for intra-wiki links | |||
*text - link text to show - optional | * <code>text</code> - link text to show - optional | ||
*attribs - extra HTML attributes to add | * <code>attribs</code> - extra HTML attributes to add - optional | ||
* <code>ext</code> - if present, the link is external | |||
===Link style=== | ===Link style=== | ||
To change the style of a link: | To change the style of a link: | ||
<pre>[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|color:gray}}</pre> | |||
[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|color:gray}} | |||
===Alternate link text style=== | ===Alternate link text style=== | ||
To change the style of a link with custom link text: | To change the style of a link with custom link text: | ||
<pre>[[Scratch Wiki|the Wiki]] vs. {{link attributes|Scratch Wiki|color:gray|text=the Wiki}}</pre> | |||
[[Scratch Wiki|the Wiki]] vs. {{link | [[Scratch Wiki|the Wiki]] vs. {{link attributes|Scratch Wiki|color:gray|text=the Wiki}} | ||
Note that you ''must'' specify <code>text=</code> to have alternate link text. | Note that you ''must'' specify <code>text=</code> to have alternate link text. | ||
===Using an external link=== | |||
To change whether it is an internal link or an external link: | |||
<pre>[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|ext=t}}</pre> | |||
[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|ext=t}} | |||
Note that you ''must'' specify <code>ext=something</code> to have an external link. (The value need not be "t" or "something", as long as it's not empty) | |||
===Red link style=== | ===Red link style=== | ||
{{note|This syntax only styles nonexistent intra-wiki links.}} | |||
To change the style of a link to a nonexistent page: | To change the style of a link to a nonexistent page: | ||
<pre>[[No page here]] vs. {{link attributes|No page here|color:gray|color:magenta}}</pre> | |||
[[No page here]] vs. {{link | [[No page here]] vs. {{link attributes|No page here|color:gray|color:magenta}} | ||
Note that the style in the '''third''' parameter is applied, since the page does not exist. | Note that the style in the '''third''' parameter is applied, since the page does not exist. | ||
===Alternate red link text style=== | ===Alternate red link text style=== | ||
{{note|This syntax only styles nonexistent intra-wiki links.}} | |||
To change the style of a link to a nonexistent page with custom link text: | To change the style of a link to a nonexistent page with custom link text: | ||
<pre>[[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope}}</pre> | |||
[[No page here|Nope]] vs. {{link | [[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope}} | ||
Here, four parameters are put into use. The first parameter is the page itself, the second is the style for the link, the third is the style if the page doesn't exist, and <code>text</code> is the alternate text for the link. | Here, four parameters are put into use. The first parameter is the page itself, the second is the style for the link, the third is the style if the page doesn't exist, and <code>text</code> is the alternate text for the link. | ||
===Extra HTML | |||
===Extra HTML attributes=== | |||
To add a <code>title</code> attribute to a link: | To add a <code>title</code> attribute to a link: | ||
<pre>[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|attribs=title="Hi, this is a demonstration of the HTML title attribute!"}} (hover)</pre> | |||
[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|attribs=title="Hi, this is a demonstration of the HTML title attribute!"}} (hover) | [[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|attribs=title="Hi, this is a demonstration of the HTML title attribute!"}} (hover) | ||
Here, the optional attribute <code>title</code> is applied to the text. | Here, the optional attribute <code>title</code> is applied to the text. | ||
===All together now=== | ===All together now=== | ||
To add a <code>title</code> attribute and change the style of a link to a nonexistent page with custom link text: | To add a <code>title</code> attribute and change the style of a link to a nonexistent page with custom link text: | ||
<pre>[[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope|attribs=title="You're not finding a page here!"}}</pre> | |||
[[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope|attribs=title="You're not finding a page here!"}} | [[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope|attribs=title="You're not finding a page here!"}} | ||
Here, | And now to link to an external page: | ||
<pre>[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|attribs=title="hehe cool"|ext=t}}</pre> | |||
[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|attribs=title="hehe cool"|ext=t}} | |||
Here, in these two examples five parameters are put into use. The first parameter is the link target, the second is the style, <code>text</code> is the link text, <code>ext</code> is to specify it as an external link, and <code>attribs</code> is the extra HTML attributes for the link. | |||
<noinclude>[[Category:Template Documentations]]</noinclude> | <noinclude>[[Category:Template Documentations]]</noinclude> | ||
Latest revision as of 23:42, 9 August 2020
 |
This is a documentation subpage for Template:Link attributes (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Usage
{{link attributes}} applies CSS style and/or HTML attributes to a link. It accepts six parameters:
- the page being linked
- the style of the link - optional
- the style of the link if the page being linked does not exist - optional - only for intra-wiki links
text- link text to show - optionalattribs- extra HTML attributes to add - optionalext- if present, the link is external
Link style
To change the style of a link:
[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|color:gray}}
Alternate link text style
To change the style of a link with custom link text:
[[Scratch Wiki|the Wiki]] vs. {{link attributes|Scratch Wiki|color:gray|text=the Wiki}}
Note that you must specify text= to have alternate link text.
Using an external link
To change whether it is an internal link or an external link:
[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|ext=t}}
Note that you must specify ext=something to have an external link. (The value need not be "t" or "something", as long as it's not empty)
Red link style
 Note: | This syntax only styles nonexistent intra-wiki links. |
To change the style of a link to a nonexistent page:
[[No page here]] vs. {{link attributes|No page here|color:gray|color:magenta}}
Note that the style in the third parameter is applied, since the page does not exist.
Alternate red link text style
| Note: | This syntax only styles nonexistent intra-wiki links. |
To change the style of a link to a nonexistent page with custom link text:
[[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope}}
Here, four parameters are put into use. The first parameter is the page itself, the second is the style for the link, the third is the style if the page doesn't exist, and text is the alternate text for the link.
Extra HTML attributes
To add a title attribute to a link:
[[Scratch Wiki]] vs. {{link attributes|Scratch Wiki|attribs=title="Hi, this is a demonstration of the HTML title attribute!"}} (hover)
Scratch Wiki vs. Scratch Wiki (hover)
Here, the optional attribute title is applied to the text.
All together now
To add a title attribute and change the style of a link to a nonexistent page with custom link text:
[[No page here|Nope]] vs. {{link attributes|No page here|color:gray|color:magenta|text=Nope|attribs=title="You're not finding a page here!"}}
And now to link to an external page:
[https://scratch.mit.edu/ Scratch] vs. {{link attributes|https://scratch.mit.edu/|color:gray|text=Scratch|attribs=title="hehe cool"|ext=t}}
Here, in these two examples five parameters are put into use. The first parameter is the link target, the second is the style, text is the link text, ext is to specify it as an external link, and attribs is the extra HTML attributes for the link.
