Last edited one year ago
by Margit Link-Rodrigue

Reference:BlueSpiceExtendedStatistics and Templates download/Icon: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
{{BSExtensionInfo
{{Featurepage|featured=false|featuredesc=New template! Easily insert Bootstrap icons on a page.|featurestart=04/06/2022}}
|status=stable
<div class="downloadarea">
|developer=HalloWelt
<span class="getButton">[[Media:HW-Icon.zip|Download]]</span>
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice free (deactivated), BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Reporting
|license=GPL v3 only
|features='''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.


ExtendedStatistics can be accessed from the pages ''Special:ExtendedStatistics'' and ''Special:AggregatedStatistic''.
[[File:Icon-template.png|350x350px|alt=example of icons on a page]]</div>This template makes it possible to insert Bootstrap icons on a page.
==Importing the template==
The import file is included in the archive file ''HW-Icon.zip''. Unpack the zip file first.


On the page ''Special:Import,'' follow these steps:
#'''''Select file''''' and choose HW-Icon.xml.
#'''Enter''' an ''interwiki prefix''. Since this field is required, simply add hw (for hallowelt).
#'''Keep''' the selection ''Import to default locations''.
#'''Click''' ''Upload file...'' .
The template is now available in your wiki.
==<span class="mw-headline" id="Pages_included_in_the_import">Pages included in the import</span>==
The xml import creates the following file in your wiki:
*Template:Icon
==<span class="mw-headline" id="Using_the_template">Using the template</span>==
{{Messagebox|boxtype=important|icon=|Note text=BlueSpice does not always include the latest version of bootstrap icons. [https://en.wiki.bluespice.com/w/skins/BlueSpiceDiscovery/resources/bootstrap/icons/index.html See the list of currently supported icons.]|bgcolor=}}
#'''Find''' a bootstrap icon from the Bootstrap website at https://icons.getbootstrap.com/<nowiki/>'''Click''' on the icon you would like to use. The icon page shows you the class-name of the icon on the right side of the page:[[File:bootstrap-award-icon.png|alt=Bootstrap icon css-class|center|thumb|650x650px|Bootstrap icon css-class]]
#'''Highlight''' the class name (it has the format ''bi bi-myicon'') and '''copy''' it to your clipboard (ctrl+c).
#'''Go back''' to your wiki page.
# '''Enter'''  <code><nowiki>{{</nowiki></code> in visual editing mode at the cursor position where you want to insert the icon. The template editor opens.
# '''Copy''' the icon class from your clipboard:[[File:template-editor-icon.png|alt=Template editor|center|thumb|450x450px|Template editor]]
# '''Change''' the font size (optional) if you want the size to be different from the text surrounding it (e.g., from the size of a heading if the icon is placed in the heading or of the paragraph text if the icon is placed in the flow-text.  Smaller than text icons are usually sized no smaller than 0.85em and larger icons up to 2.5em.
#'''Color:''' If you want the color to be different from the surrounding text, you can specify any web color (e.g., a color name like blue or a hex-valuesuch as #0059b3 for a more specific blue). A list of web colors can be found at https://www.w3schools.com/colors/colors_picker.asp
#'''Vertical alignment:''' It should not be necessary to provide an alignment value. The standard is set to text-top and usually works in headings and in flow-text. If it looks a little off, you can try other vertical-alignment values, such as text-bottom. For a full list of possible values, see https://www.w3schools.com/cssref/pr_pos_vertical-align.asp.
#'''Click''' ''Apply changes''.


For the Snapshot statistics (=AggregatedStatistic) to return any data, the following cronjob needs to run:


In <code>crontab -e</code>:
The icon is now displayed on the page.
<code>0 1 * * * php <path-to-wiki>/extensions/BlueSpiceExtendedStatistics/maintenance/generateSnapshot.php --interval=day --skip-timecheck</code>


It offers analysis of many aspects of wiki, like:
[[File:bootstrap-icon-on page.png|alt=Inserted Bootstrap icon|center|thumb|450x450px|Inserted Bootstrap icon]]
 
*Number of users.
*Number of pages.
*Edits per user.
*Search queries and more.
 
This data can be filtered:
 
*By defining the period (from and to date).
*Granulation (interval to show on diagram - day, week, month, year).
*Type (absolute, aggregate and list modes).
*Additional filters depending of the data being represented.
 
Some aspects of this extension can be configured with the [[Special:BlueSpiceConfigManager{{!}}Config manager]], under ''ExtendedStatistics''. Here, wiki administrators can configure:
 
*the users to exclude from statistical analysis
*the maximum number of interval steps
|desc=Provides an analytic view of many relevant parameters on the wiki.
}}
{{wcagCheck
|wcagStatus=2-testing complete
|wcagCheckedfor=Web
|wcagTestdate=2022-08-08
|wcagLevel=AA
|wcagSupport=does not support
|wcagWorkaround=no
|wcagComments=most output formats only available and exportable as svg and not in text-based format.
|extensionType=extended
|extensionFocus=admin
}}

Revision as of 10:51, 23 February 2023

Download

example of icons on a page

This template makes it possible to insert Bootstrap icons on a page.

Importing the template

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

On the page Special:Import, follow these steps:

  1. Select file and choose HW-Icon.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 file in your wiki:

  • Template:Icon

Using the template

Important!BlueSpice does not always include the latest version of bootstrap icons. See the list of currently supported icons.
  1. Find a bootstrap icon from the Bootstrap website at https://icons.getbootstrap.com/Click on the icon you would like to use. The icon page shows you the class-name of the icon on the right side of the page:
    Bootstrap icon css-class
    Bootstrap icon css-class
  2. Highlight the class name (it has the format bi bi-myicon) and copy it to your clipboard (ctrl+c).
  3. Go back to your wiki page.
  4. Enter {{ in visual editing mode at the cursor position where you want to insert the icon. The template editor opens.
  5. Copy the icon class from your clipboard:
    Template editor
    Template editor
  6. Change the font size (optional) if you want the size to be different from the text surrounding it (e.g., from the size of a heading if the icon is placed in the heading or of the paragraph text if the icon is placed in the flow-text. Smaller than text icons are usually sized no smaller than 0.85em and larger icons up to 2.5em.
  7. Color: If you want the color to be different from the surrounding text, you can specify any web color (e.g., a color name like blue or a hex-valuesuch as #0059b3 for a more specific blue). A list of web colors can be found at https://www.w3schools.com/colors/colors_picker.asp
  8. Vertical alignment: It should not be necessary to provide an alignment value. The standard is set to text-top and usually works in headings and in flow-text. If it looks a little off, you can try other vertical-alignment values, such as text-bottom. For a full list of possible values, see https://www.w3schools.com/cssref/pr_pos_vertical-align.asp.
  9. Click Apply changes.


The icon is now displayed on the page.

Inserted Bootstrap icon
Inserted Bootstrap icon
Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Reference:BlueSpiceExtendedStatistics&oldid=5574"
No categories assignedEdit

Discussions