Manual:Extension/ExternalContent: Difference between revisions

m Text replacement - "External Content" to "ExternalContent"
No edit summary
Tag: 2017 source edit
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
[[File:external template copy and paste.png|alt=Open menu for adding link parameters|center|thumb|650x650px|Pasting a github url directly into the visual editor.]]
[[File:external template copy and paste.png|alt=Open menu for adding link parameters|center|thumb|650x650px|Pasting a github url directly into the visual editor.]]


{| class="wikitable"
|+
!Parameter
!Description
|-
|URL
|External location of the embedded file.
|-
|Language of embedded content
|One of the supported languages ​​[https://prismjs.com/#supported-languages]. Only required if the language is not detected by the file extension.


|-
|Lines to show
|Show only specific lines. This can be a single line number or a range separated by a hyphen (-). Multiple line numbers or ranges can be separated by commas.


=== Content droplet ===
|-
To embed a GitHub or Bitbucket link, you can also select the related Content droplet:
|Show line numbers
|Displays the line numbers of the embedded block.
 
|}
 
=== Content Droplet ===
To embed a GitHub or Bitbucket link, you can also select the related Content Droplet:


* External content (for GitHub)
* External content (for GitHub)
* Bitbucket file
* Bitbucket file
[[File:Extension ExternalContent - Bitbucket file.png|alt=12 lines of code from a public Bitbucket file|center|thumb|650x650px|Bitbucket content]]
[[File:Extension External Content - Bitbucket file.png|alt=12 lines of code from a public Bitbucket file|center|thumb|650x650px|Bitbucket content]]


{{Textbox|boxtype=important|header=Error messages:|text=If an error message appears after embedding a Bitbucket or GitHub file, it may be that specific domains for embedding have been defined in the [[#Configuring allowed external content|Configuration management]]. These must then be adjusted accordingly.|icon=yes}}


== Suppressing the conversion of an external link ==
== Suppressing the conversion of an external link ==
​If you want to post a link to the external page instead, you need to paste the url into the "Insert link" menu. After adding the link you can add a label, since external links that are created with the "insert link" menu do not automatically show the full url or a link label.
​If you want to create a link to the external page instead of embedding it, you must copy the URL into the page as plain text (e.g., using the keyboard shortcut <code>Ctrl+Shift+V</code>).
[[File:external content github link.png|alt="Insert link" menu with link to github content|center|thumb|750x750px|Link to github content]]
[[Category:Content]]
[[Category:Content]]


Line 28: Line 49:


{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#Editor (External content)}}
{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#Editor (External content)}}
{{translation}}

Latest revision as of 09:09, 28 January 2026


ChatBot is available from BlueSpice 5.2. This extension has multiple prerequesites before it is available to users in a wiki.


The ExternalContent extension allows for embedding external content, such as markdown files, in your wiki pages. The standard configuration allows embedding links from GitHub and Bitbucket.

Embedding external content

Copy and paste

In visual editing mode, you can simply copy the url to your clipboard and paste it into the wiki page in visual editing mode. The visual editor will automatically convert the url to an embedded view of the actual external content.

Open menu for adding link parameters
Pasting a github url directly into the visual editor.
Parameter Description
URL External location of the embedded file.
Language of embedded content One of the supported languages ​​[1]. Only required if the language is not detected by the file extension.
Lines to show Show only specific lines. This can be a single line number or a range separated by a hyphen (-). Multiple line numbers or ranges can be separated by commas.
Show line numbers Displays the line numbers of the embedded block.

Content Droplet

To embed a GitHub or Bitbucket link, you can also select the related Content Droplet:

  • External content (for GitHub)
  • Bitbucket file
12 lines of code from a public Bitbucket file
Bitbucket content


Error messages: If an error message appears after embedding a Bitbucket or GitHub file, it may be that specific domains for embedding have been defined in the Configuration management. These must then be adjusted accordingly.


Suppressing the conversion of an external link

​If you want to create a link to the external page instead of embedding it, you must copy the URL into the page as plain text (e.g., using the keyboard shortcut Ctrl+Shift+V).

Configuring allowed external content

In the configuration manager, you can restrict the domains and file types that can be embedded in the wiki:


Included starting with   v5.2+.

  • Domain whitelist: List of domains whose content can be embedded in the wiki. If no domains are defined, there are no domain restrictions.
Important! For Github content, you have to allow raw.githubusercontent.com.


  • Field extension whitelist: List of file extensions that can be embedded from external content in the wiki.



PDF exclude - start

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

PDF exclude - end