Difference between revisions of "Manual:Extension/BlueSpiceCountThings"
[unchecked revision] | [unchecked revision] |
Fbaeckmann (talk | contribs) |
(Tag: 2017 source edit) |
Contents
- 1 What is CountThingsBlueSpiceCountThings?
- 2 Using BlueSpiceCountThings
- 3 Where to find CountThings
-
BlueSpiceCountThings?
- 2
- 2
- 3
- 4 See also
What is CountThingsBlueSpiceCountThings?[edit | edit source]
CountThings BlueSpiceCountThings introduces a set of tags that allow for counting various metadata in the wiki. These information will be displayed on page in the configurable table.
Where to find CountThings?Using BlueSpiceCountThings[edit | edit source]
You only see the function when you or another author integrated the special tag into an article. Everybody with writing permissions can use the tag, everyone with reading permissions can see the infobox as a result.
"Edit" and "Insert magic word or tag":
You can choose what you want count on your Page / Article:
countusers - shows number of users currently logged in the wiki.
countarticles - shows number of pages currently existing on the wiki.
countcharacters - shows information on the particular article. It can show different information depending on the modeTags made available by this extensions are:
- countarticles - Displays total number of articles on the wiki
- countusers - Displays total number of users registered on the wiki
- countfiles - Displays total number of files uploaded to the wiki
-
countcharacters - This tag can be set up in several modes:
- Chars – number of characters on
- current page (based on the wiki code, including spaces)
- Words – number of words on
- current page
- Pages – number of pages
- current article would have if printed/exported
- All – default mode – shows all the information above
For Example we will count characters:
You will get wiki code: "<bs:countcharacters>ARTICLENAME</bs:countcharacters>"
Instead ARTICLENAME you must type Name of your Article.
In this case name of my Article is: TestPage.
So, wiki code will look like this: "<bs:countcharacters>TestPage</bs:countcharacters>"-
- in a table
Where to find BlueSpiceCountThings?[edit | edit source]
In order for information from this extension to be displayed on page, an editor must add desired tags on the page.
Tags are added through InsertMagic dialog, which can be accessed by clicking on "Insert" in VisualEditor toolbar and then on "Magic word". In the resulting dialog, choose one of the four previously mentioned types of tags and click "Done".
Save and you should get:
Number of articles on the wiki[edit | edit source]
This number is based on the database table page
.
<bs:countarticles />
Number of characters, words and pages (2000 characters = 1 Page) of an article[edit | edit source]
If you want to show all information (characters, words and pages) of an article, please use this code:
<bs:countcharacters>ARTICLENAME</bs:countcharacters>
ARTICLENAME is: Name of your page.
If you just want to show part of the information, please choose between these different modes:
-
- chars: Only number of characters.
- words: Only number of words.
- pages: Only number of pages.
- all (Standard): All informations.
The mode is defined with "mode" Attribute:
<bs:countcharacters mode="chars">Name of the article</bs:countcharacters><br>
Number of users in a system (users who are signed-in)[edit | edit source]
<bs:countusers />
The code has to be integrated directly into the article.
See also[edit | edit source]
Our reference page.
<bs:bookshelf src="Book:User manual" /> __TOC__ ==What is CountThings?== '''CountThingsBlueSpiceCountThings?== '''BlueSpiceCountThings''' introduces a set of tags that allow for counting various metadata in the wiki. These information will be displayed on page in the configurable table. ==Where to find CountThings?== You only see the function when you or another author integrated the special tag into an article. Everybody with writing permissions can use the tag, everyone with reading permissions can see the infobox as a result. "Edit" and "Insert magic word or tag": ::: [[File:CntTngs1.jpg|500x305px]] You can choose what you want count on your Page / Article: countusers - shows number of users currently logged in the wiki. countarticles - shows number of pages currently existing on the wiki. countcharacters - shows information on the particular article. It can show different information depending on the mode: *Using BlueSpiceCountThings== Tags made available by this extensions are: * countarticles - Displays total number of articles on the wiki * countusers - Displays total number of users registered on the wiki * countfiles - Displays total number of files uploaded to the wiki * countcharacters - This tag can be set up in several modes: ** Chars – number of characters on thecurrent page (based on the wiki code, including spaces). * ** Words – number of words on thecurrent page. * ** Pages – number of pages thiscurrent article would have if printed/exported. * ** All – default mode – shows all the information above. ::: [[File:CntTngs2.jpg|500x307px]] For Example we will count characters: ::: [[File:CntTngs3.jpg|500x307px]] You will get wiki code: <nowiki>"<bs:countcharacters>ARTICLENAME</bs:countcharacters>"</nowiki> Instead ARTICLENAME you must type Name of your Article. ::: [[File:CntTngs4.jpg|500x309px]] In this case name of my Article is: TestPage. So, wiki code will look like this: <nowiki>"<bs:countcharacters>TestPage</bs:countcharacters>"</nowiki> in a table ==Where to find BlueSpiceCountThings?== In order for information from this extension to be displayed on page, an editor must add desired tags on the page. Tags are added through InsertMagic dialog, which can be accessed by clicking on "Insert" in VisualEditor toolbar and then on "Magic word". In the resulting dialog, choose one of the four previously mentioned types of tags and click "Done". ::: [[File:CntTngs5.jpg|500x311px]] Save and you should get: ::: [[File:CntTngs6.jpg|500x309px]] ===Number of articles on the wiki=== This number is based on the database table <code>page</code>. <nowiki><bs:countarticles /></nowiki> ===Number of characters, words and pages (2000 characters = 1 Page) of an article=== If you want to show all information (characters, words and pages) of an article, please use this code: <nowiki><bs:countcharacters>ARTICLENAME</bs:countcharacters></nowiki> ARTICLENAME is: Name of your page. If you just want to show part of the information, please choose between these different modes: :* <tt>chars</tt>: Only number of characters. :* <tt>words</tt>: Only number of words. :* <tt>pages</tt>: Only number of pages. :* <tt>all</tt> (Standard): All informations. The mode is defined with "mode" Attribute: <nowiki><bs:countcharacters mode="chars">Name of the article</bs:countcharacters><br></nowiki> ===Number of users in a system (users who are signed-in)=== <nowiki><bs:countusers /></nowiki> The code has to be integrated directly into the article. ==See also== Our [[CountThings|reference page]].
Line 1: | Line 1: | ||
− | |||
− | |||
__TOC__ | __TOC__ | ||
− | ==What is | + | ==What is BlueSpiceCountThings?== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | '''BlueSpiceCountThings''' introduces a set of tags that allow for counting various metadata in the wiki. These information will be displayed on page in the configurable table. | |
− | + | ==Using BlueSpiceCountThings== | |
+ | Tags made available by this extensions are: | ||
+ | * countarticles - Displays total number of articles on the wiki | ||
+ | * countusers - Displays total number of users registered on the wiki | ||
+ | * countfiles - Displays total number of files uploaded to the wiki | ||
+ | * countcharacters - This tag can be set up in several modes: | ||
+ | ** Chars – number of characters on current page (based on the wiki code, including spaces) | ||
+ | ** Words – number of words on current page | ||
+ | ** Pages – number of pages current article would have if printed/exported | ||
+ | ** All – default mode – shows all the information above in a table | ||
+ | ==Where to find BlueSpiceCountThings?== | ||
+ | In order for information from this extension to be displayed on page, an editor must add desired tags on the page. | ||
− | + | Tags are added through InsertMagic dialog, which can be accessed by clicking on "Insert" in VisualEditor toolbar and then on "Magic word". In the resulting dialog, choose one of the four previously mentioned types of tags and click "Done". | |
::: [[File:CntTngs5.jpg|500x311px]] | ::: [[File:CntTngs5.jpg|500x311px]] |