2.2.4 Links

(Replaced content with "<bookshelf src="Book:User manual" />")
Tag: Replaced
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<bookshelf src="Book:User manual" />
<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Insert links}}
==How do I create links?==
Linking pages is an important feature of browser-based documentation. The links can differ in their function. Links connect wiki pages with:
*other wiki pages
*external websites
*files (images, PDF files, Word documents,...)
*files stored on other drives
Use the ''Insert link'' menu item in [[Manual:Extension/VisualEditor|VisualEditor]] or use the shortcut ''Ctrl+K''. In both cases, a dialog box opens.
<br /><span><span /></span>[[File:Insert_link.png|alt=Dialog box with a link the page "Templates"|center|thumb|351x351px|Linking pages]]
==Link to a wiki page==
Internal links connect related pages or other content that provides more information. Page names can exist multiple times in different namespaces. Therefore, under ''Search pages'', enter the namespace if the destination page is not in the same namespace as the current page.
If you have selected some text on the page, you will find some page suggestions already listed in the ''Search pages'' tab. Here, you can adjust the search term accordingly or create a link to a new page.
{{Textbox|boxtype=note|header=Note about the search feature:|text=Pages in the namespace are only found if you provide the namespace-prefix. For subpages, the parent page name also needs to be added in addition, before the subpage can be found.|icon=yes}}
Then click on ''Done''.
<span><span /><br /></span>
In the source text,  links are created with the following structure:
*'''Link to a wiki page:''' <code><nowiki>[[landing page name|caption]]</nowiki></code>
*'''Link to a wiki page in another namespace:''' <code><nowiki>[[namespace:landing page name|caption]]</nowiki></code>
*'''Link to a category page:''' <code><nowiki>[[:Category:category name|caption]]</nowiki></code> To create a link to a category, the source code is preceded by a colon before the category name. In contrast, the link "Category: BlueSpice" would create a category called BlueSpice instead of linking to the category BlueSpice.
*'''[[Manual:Extension/BlueSpiceInterWikiLinks|Interwiki link]]:''' <code><nowiki>[[Imdb:tt2709692]]</nowiki></code>If your wiki links to other wikis, you can use the tab ''Search pages'' also to directly link to a page in a related wiki. For example, if your administrator maintains an interwiki link for the IMDb movie database, it can be typed in as in the example above. Ask your administrator which interwiki links are available in your wiki.
== Link to a page section ==
You can link directly to a specific section of a page using an "anchor":
# In view mode, click directly on the link icon to the left of the section heading (it appears when you hover over the heading). This copies the anchor to the clipboard.[[File:anchor link.png|alt=mouse pointer hovering over the anchor symbol|center|thumb|200x200px|Anchor link]]
# Paste the link from your clipboard into the dialog box for creating a link using <code>Ctrl</code>+<code>V</code>.
==Link to an external website==
To link to an external website, mark text on your page, e.g. the word "Wikipedia". Press Ctrl+K and switch to the tab ''External link''. There you enter the web address. Then click ''Insert''.
[[File:External_link.png|alt=External link tab with link to wikipedia.org|center|thumb|350x350px|Linking to an external page]]
{{Messagebox|boxtype=note|Note text=To easily maintain external links on your wiki, use the page [[Special:LinkSearch]]. This page allows you to search for external links in your entire wiki. The page also contains a link to the associated Mediawiki help page.}}
==Link to a file page in the wiki==
To linkto a file page (for example, the description page for a picture or a PDF), switch to the ''Link to File'' tab. There, you can search for a file.
<br />
[[File:Links.png|alt=Insert link to a file|center|thumb|350x350px|Insert link to a file]]
{{Textbox|boxtype=note|header=Linking directly to a PDF|text=To link a file directly (so that, for example, a PDF opens immediately after clicking on the link), insert the link by clicking on the menu item Insert and then Images and Media.|icon=yes}}
*'''Link file to a network drive:''' If you want to connect to a file on your company network, enter the path under "Link to file" in the text field and activate "Network share path (URI)". The file path is entered using the following syntax - <code>[[:file:///Z:/myfolder/vacatio]<nowiki>]</nowiki></code>. this only works if your wiki has been configured to work with network files. This function also depends on your individual browser security settings.<br /><br />[[File:Linkk.png|alt=Link to a network file|center|thumb|300x300px|Link to a network file]]
==Link to a file in the local network==
If you want to link to a file on your company network, you can use the ''Link to File'' tab. The ability to directly access a file on a network drive via the browser no longer works in modern browsers for security reasons at this point, but is listed here for the sake of completeness.
{{Messagebox|boxtype=important|Note text=Links to network drives (UNC links) pose a security risk. Therefore, current browsers block these links by default.
It is also possible that your wiki has been configured to disable links to network files.
Talk to your IT department if you have any questions about guidelines related to your browser. If your IT department does not offer a solution, files linked in the wiki can still be copied by wiki users and pasted into the address bar of Windows Explorer.
For more info about UNC-Links, see: https://www.mediawiki.org/wiki/UNC_links.}}
<span><span /><br /></span>
'''Insert a link to a local network file:'''
[[File:Manual:ve-link-einfügen-EN.png|alt=Insert local file link|center|thumb|350x350px|Insert local file link]]
#'''Click''' ''Insert link'' in the visual editor.
#'''Click''' on the tab ''Link to file.''
#'''''Activate''''' ''the switch Netzwerkpfad (URI).'' In the file search field (4) you now see the link symbol.
#'''Enter''' the path to your file.  You can get this path by right-clicking on the file properties in Windows Explorer. From the tab ''Security'' you can copy the object name and paste it into the wiki accordingly. <span /><span /><br />[[File:Manual:ve-link-einfügen-pfad-EN.png|alt=Security tab in the Properties dialog box of a network drive file|center|thumb|439x439px|File properties]]<span /><span /><br />
#'''Click''' ''Insert''. The link is automatically added in the correct format (<code><nowiki>file://S:/7_Benutzer/</nowiki>....</code>). Whether the link can be directly followed through the browser, depends on your browser security settings and installed add-ons. Talk to your IT department to get help if the links are not active.
==Open internal links in new browser tab==
By default, external links open in a new browser tab. If you also want to open individual internal links in a new tab, you can insert the following JavaScript on the ''MediaWiki:Common.js'' page:<syntaxhighlight lang="javascript">
/**
* @source https://www.mediawiki.org/wiki/Snippets/Open_specific_links_in_new_window
* @version 2018-09-15
*/
$( function () {
$( '#mw-content-text' ).on( 'click', '.newwin > a', function () {
var otherWindow = window.open();
otherWindow.opener = null;
otherWindow.location = this;
return false;
} );
} );
</syntaxhighlight>Add the link you want to open in a new tab as wikitext to your page.<syntaxhighlight lang="text">
<span class="newwin">[[Meine Seite]]</span>
</syntaxhighlight>
== Permalinks (revision-specific) ==
Every time a user saves changes to a page (revisions), a version with a specific version number is created. Therefore, each version  has its own web address (URL). This is also known as a permanent link or "permalink" and is accessible as follows:
# Via the "Share" link in the side toolbar. The permalink of the currently loaded page version is placed on the clipboard. Click on the "Share" icon and select "Copy URL".[[File:Toolbar Share URL.png|alt=The expanded "Share page" menu from the toolbar|center|thumb|300x300px|Copy the permanent link]]
# Via the "Version history". In the side toolbar, click "View history", then click a version's date stamp. The web address of the page now displays the permalink. [[File:Permalink version history.png|center|thumb|650x650px|Copy the permalink from the Version history|alt=Browser context menu for a specific page version]]
Both approaches create a permalink that depends on the name of the page:<syntaxhighlight lang="text">
https://en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceInsertLink&oldid=5300
</syntaxhighlight>If the page is moved, and therefore has a different title, the permalink will still work based on the "oldid". {{Textbox|boxtype=tip|header=Tip:|text=In both cases, external links are created, for example for copying into an e-mail or another website. To create an internal permalink, you must create a link via the special page "PermanentLink" (see next section).|icon=yes}}
=== Internal permalink ===
A shortened permalink can be inserted in the source code of the page in the following way:<syntaxhighlight lang="text">
[[Special:PermanentLink/5300]]
</syntaxhighlight>Use the visual editor to enter the link using the link button ([[File:Manual:VE Insert hyperlink.png|alt=menu item "Insert link"|35x35px]]):
[[File:Permalink insert visually.png|alt=Dialog box for using the  "PermanentLink" syntax|center|thumb|350x350px|internal linking of a permalink]]
{{Box Links-en|Topic1=https://www.mediawiki.org/wiki/Help:Links |Topic2 = [[Manual:Extension/VisualEditor]]}}
{{translation}}
[[Category:Editing]]

Latest revision as of 14:08, 16 May 2024


How do I create links?

Linking pages is an important feature of browser-based documentation. The links can differ in their function. Links connect wiki pages with:

  • other wiki pages
  • external websites
  • files (images, PDF files, Word documents,...)
  • files stored on other drives


Use the Insert link menu item in VisualEditor or use the shortcut Ctrl+K. In both cases, a dialog box opens.


Dialog box with a link the page "Templates"
Linking pages

Link to a wiki page

Internal links connect related pages or other content that provides more information. Page names can exist multiple times in different namespaces. Therefore, under Search pages, enter the namespace if the destination page is not in the same namespace as the current page.

If you have selected some text on the page, you will find some page suggestions already listed in the Search pages tab. Here, you can adjust the search term accordingly or create a link to a new page.

Note about the search feature:Pages in the namespace are only found if you provide the namespace-prefix. For subpages, the parent page name also needs to be added in addition, before the subpage can be found.


Then click on Done.


In the source text, links are created with the following structure:

  • Link to a wiki page: [[landing page name|caption]]
  • Link to a wiki page in another namespace: [[namespace:landing page name|caption]]
  • Link to a category page: [[:Category:category name|caption]] To create a link to a category, the source code is preceded by a colon before the category name. In contrast, the link "Category: BlueSpice" would create a category called BlueSpice instead of linking to the category BlueSpice.
  • Interwiki link: [[Imdb:tt2709692]]If your wiki links to other wikis, you can use the tab Search pages also to directly link to a page in a related wiki. For example, if your administrator maintains an interwiki link for the IMDb movie database, it can be typed in as in the example above. Ask your administrator which interwiki links are available in your wiki.

Link to a page section

You can link directly to a specific section of a page using an "anchor":

  1. In view mode, click directly on the link icon to the left of the section heading (it appears when you hover over the heading). This copies the anchor to the clipboard.
    mouse pointer hovering over the anchor symbol
    Anchor link
  2. Paste the link from your clipboard into the dialog box for creating a link using Ctrl+V.

Link to an external website

To link to an external website, mark text on your page, e.g. the word "Wikipedia". Press Ctrl+K and switch to the tab External link. There you enter the web address. Then click Insert.

External link tab with link to wikipedia.org
Linking to an external page
Note:To easily maintain external links on your wiki, use the page Special:LinkSearch. This page allows you to search for external links in your entire wiki. The page also contains a link to the associated Mediawiki help page.


Link to a file page in the wiki

To linkto a file page (for example, the description page for a picture or a PDF), switch to the Link to File tab. There, you can search for a file.

Insert link to a file
Insert link to a file
Linking directly to a PDFTo link a file directly (so that, for example, a PDF opens immediately after clicking on the link), insert the link by clicking on the menu item Insert and then Images and Media.
  • Link file to a network drive: If you want to connect to a file on your company network, enter the path under "Link to file" in the text field and activate "Network share path (URI)". The file path is entered using the following syntax - [[:file:///Z:/myfolder/vacatio]]. this only works if your wiki has been configured to work with network files. This function also depends on your individual browser security settings.

    Link to a network file
    Link to a network file

Link to a file in the local network

If you want to link to a file on your company network, you can use the Link to File tab. The ability to directly access a file on a network drive via the browser no longer works in modern browsers for security reasons at this point, but is listed here for the sake of completeness.

Important!Links to network drives (UNC links) pose a security risk. Therefore, current browsers block these links by default.


It is also possible that your wiki has been configured to disable links to network files.


Talk to your IT department if you have any questions about guidelines related to your browser. If your IT department does not offer a solution, files linked in the wiki can still be copied by wiki users and pasted into the address bar of Windows Explorer.


For more info about UNC-Links, see: https://www.mediawiki.org/wiki/UNC_links.



Insert a link to a local network file:

Insert local file link
Insert local file link
  1. Click Insert link in the visual editor.
  2. Click on the tab Link to file.
  3. Activate the switch Netzwerkpfad (URI). In the file search field (4) you now see the link symbol.
  4. Enter the path to your file. You can get this path by right-clicking on the file properties in Windows Explorer. From the tab Security you can copy the object name and paste it into the wiki accordingly.
    Security tab in the Properties dialog box of a network drive file
    File properties

  5. Click Insert. The link is automatically added in the correct format (file://S:/7_Benutzer/....). Whether the link can be directly followed through the browser, depends on your browser security settings and installed add-ons. Talk to your IT department to get help if the links are not active.

Open internal links in new browser tab

By default, external links open in a new browser tab. If you also want to open individual internal links in a new tab, you can insert the following JavaScript on the MediaWiki:Common.js page:
/**
 * @source https://www.mediawiki.org/wiki/Snippets/Open_specific_links_in_new_window
 * @version 2018-09-15
 */
$( function () {
	$( '#mw-content-text' ).on( 'click', '.newwin > a', function () {
		var otherWindow = window.open();
		otherWindow.opener = null;
		otherWindow.location = this;
		return false;
	} );
} );
Add the link you want to open in a new tab as wikitext to your page.
<span class="newwin">[[Meine Seite]]</span>

Permalinks (revision-specific)

Every time a user saves changes to a page (revisions), a version with a specific version number is created. Therefore, each version has its own web address (URL). This is also known as a permanent link or "permalink" and is accessible as follows:

  1. Via the "Share" link in the side toolbar. The permalink of the currently loaded page version is placed on the clipboard. Click on the "Share" icon and select "Copy URL".
    The expanded "Share page" menu from the toolbar
    Copy the permanent link
  1. Via the "Version history". In the side toolbar, click "View history", then click a version's date stamp. The web address of the page now displays the permalink.
    Browser context menu for a specific page version
    Copy the permalink from the Version history
Both approaches create a permalink that depends on the name of the page:
https://en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceInsertLink&oldid=5300
If the page is moved, and therefore has a different title, the permalink will still work based on the "oldid".
Tip:In both cases, external links are created, for example for copying into an e-mail or another website. To create an internal permalink, you must create a link via the special page "PermanentLink" (see next section).


Internal permalink

A shortened permalink can be inserted in the source code of the page in the following way:
[[Special:PermanentLink/5300]]
Use the visual editor to enter the link using the link button (menu item "Insert link"):
Dialog box for using the "PermanentLink" syntax
internal linking of a permalink



Related info



To submit feedback about this documentation, visit our community forum.