Templates download/BookTOC: Difference between revisions

(Created page with "{{Textbox|boxtype=note|header=|text=Starting with BlueSpice 4.3, these button links can be inserted as a Content droplet. Therefore, importing this template is no longer necessary.|icon=yes}}<div class="downloadarea"> <span class="getButton">Download</span> 350x350px </div>This template creates a link that is styled as a button. It can be inserted into a wiki page via the Visual...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Textbox|boxtype=note|header=|text=Starting with BlueSpice 4.3, these button links can be inserted as a [[Manual:Extension/ContentDroplets|Content droplet]]. Therefore, importing this template is no longer necessary.|icon=yes}}<div class="downloadarea">
<div class="downloadarea">
<span class="getButton">[[Media:HW-ButtonLink.zip|Download]]</span>
<span class="getButton">[[Media:HW-Bookchapters.zip|Download]]</span>


[[File:HW-ButtonLink.png|350x350px]]
[[File:BookTOC.png|alt=Embedded book TOC|300x300px]]
</div>This template creates a link that is styled as a button. It can be inserted into a  wiki page via the VisualEditor ''Insert > Template'' menu.
 
</div>This template allows to embed the Table of Contents of a book on any wiki page. It can be inserted into a  wiki page via the VisualEditor ''Insert > Template'' menu.
==Importing the template==
==Importing the template==
The import file is included in the archive file ''HW-ButtonLink.zip''. Unpack the zip file first.
The import file is included in the archive file ''HW-Bookchapters.zip''. Unpack the zip file first.


On the page ''Special:Import'' follow these steps:
On the page ''Special:Import'' follow these steps:


#'''Select file''' and choose ''HW-ButtonLink.xml''.
#'''Select file''' and choose ''hwBookchapters.xml''.
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Enter''' an Interwiki prefix. Since this field is required, simply add ''hw'' (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .
#'''Click''' ''Upload file...'' .


The template is now available in your wiki.{{Messagebox|boxtype=important|Note text=The input fields for the template parameters are usually not automatically available after importing the template to your wiki . You have to open the imported template file and make an edit (e.g., add a space and then save the page) to activate the template data functionality. The input fields should now be displayed correctly when you use the template on a page.}}
The template is now available in your wiki.
==Pages included in the import==
== Pages included in the import==
The xml import creates the following files in your wiki:
The xml import creates the following files in your wiki:


*Template:ButtonLink
*Template:Bookchapters
*Template:Bookchapters/styles.css


==Using the template==
==Using the template==


#Add the template from the [[Manual:Extension/VisualEditor|VisualEditor]] insert-dialog.
# '''Insert''' the template from the Visual Editor.
#Fill in the form fields as needed.
#'''Enter''' the title of the book.
#'''Click''' ''Apply changes''.
 
[[File:BookTOC.png|alt=Embedded book TOC|Book chapters on a wiki page|thumb|center|350x350px]]
 
The table of contents is now displayed on the page.
 
{{Messagebox|boxtype=note|Note text=It is not possible to collapse the sub-chapters.}}
 
 


[[File:HW-ButtonLink-templatedata.png|center|thumb|450x450px|Insert-dialog for button link|link=Special:FilePath/HW-ButtonLink-templatedata.png]]


===Settings===
{| class="contenttable-blue" style="width:100%;"
! style="width:200px;" |Input field
!Description
|-
| style="width:200px;" |Is this an external link?
|yes = the link target starts with http:// or https://
Leave blank for internal wiki page
|-
| style="width:200px;" |Link target
|Name of the wiki page or the website
|-
| style="width:200px;" |Label
|Label shown on the button
|-
| style="width:200px;" |Background color
|Possible button colors: red, blue (leave blank for white)
|}





Latest revision as of 12:57, 4 August 2023

This template allows to embed the Table of Contents of a book on any wiki page. It can be inserted into a wiki page via the VisualEditor Insert > Template menu.

Importing the template

The import file is included in the archive file HW-Bookchapters.zip. Unpack the zip file first.

On the page Special:Import follow these steps:

  1. Select file and choose hwBookchapters.xml.
  2. Enter an Interwiki prefix. Since this field is required, simply add hw (for hallowelt).
  3. Keep the selection Import to default locations.
  4. Click Upload file... .

The template is now available in your wiki.

Pages included in the import

The xml import creates the following files in your wiki:

  • Template:Bookchapters
  • Template:Bookchapters/styles.css

Using the template

  1. Insert the template from the Visual Editor.
  2. Enter the title of the book.
  3. Click Apply changes.
Embedded book TOC
Book chapters on a wiki page

The table of contents is now displayed on the page.

Note:It is not possible to collapse the sub-chapters.









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