Difference between revisions of "Manual:Extension/BlueSpiceCountThings"

[unchecked revision][quality revision]
(Tag: 2017 source edit)

What is About BlueSpiceCountThings?[edit | edit source]

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[edit | edit source]

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

Available tags: countarticles, countusers, countfiles, and countcharacters.

Inserting tags[edit | edit source]

In order for information from this extension to be displayed on page, an editor must add desired tags on the page.

Insert magic word
Insert magic word

Tags are added through the "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".

Checklist1.png
choosing a tag
CountThings1.png
choosing a tag

Configuring the countcharacters tag[edit | edit source]

CountThings2.png

While other tags have no configuration options, and just adding them to the page is sufficient, "the countcharacters" tag must first be configured.

After inserting this tag , or clicking on an existing tag already on the page, a dialog for configuration (inspector) will open. In this dialog, in the main text input field, the opens.

Count characters dialog box
Count characters dialog box
Redlink page
Redlink page

Enter the name of the page for which to count characters must be inserted. This name should include the namespace in case if the page is not in the main namespace. Below the text input field, there is a dropdown box to select the mode (see above)Next, select the mode from the dropdown menu.

While selecting the mode and page, a preview of the output is displayed. above the dialog box. If the page title in the table heading shows the page name in red ("redlink"), you have misspelled the page name and the page does not exist.

Inserting tags in wikitext[edit | edit source]

"countcharacters" tag in mode "All" on saved page

In addition to using the visual editing mode, tags can be inserted using wikitext syntax as well. Use the following syntax when inserting tags directly in wikitextIf you add the tags in source code edit mode, use the following syntax.

<bs:countarticles />
<bs:countusers />
<bs:countfiles />
<bs:countcharacters mode="Words">ARTICLENAME</bs:countcharacters>

For the "countcharacters" tag, replace ARTICLENAME with proper page titlethe page name for which you want to get the count values. Also, "mode" can be adjusted as needed. For details, visit the reference page:

Related info


            __TOC__
        

        ==What is About 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
            

            ==Inserting tags==
            
            In order for information from this extension to be displayed on page, an editor must add desired tags on the page.
            
Available tags: countarticles, countusers, countfiles, and countcharacters.
            

            ==Inserting tags==
            
            [[File:Manual:ve-magicword.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:ve-magicword.png|alt=Insert magic word|thumb|151x151px|Insert magic word]]
            Tags are added through the "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:Checklist1.png|thumb]]
            
            |[[File:CountThings1.png|thumb]]
            
            |}
            

            ===Configuring countcharacters tag===
            
            [[File:CountThings2.png|thumb]]
            <br />
            
            [[File:Manual:VE-magicword-countarticles.png|alt=choosing a tag|center|thumb|450x450px|choosing a tag]]
            

            ===Configuring the countcharacters tag===
            While other tags have no configuration options, and just adding them to the page is sufficient, "the ''countcharacters"'' tag must first be configured.
        

        After inserting this tag, or clicking on an existing tag already on the page, a dialog for configuration (inspector) will open.
            
            In this dialog, in the main text input field, the  opens.
            
            [[File:Manual:VE-magicword-countcharacterswords.png|alt=Count characters dialog box|center|thumb|600x600px|Count characters dialog box]]
            
            [[File:Manual:VE-magicword-countcharactersredlink.png|alt=Redlink page|thumb|180x180px|Redlink page]]
            
            Enter the  name of the page for which to count characters must be inserted.
        
        This name should include the namespace in case if the page is not in the main namespace.
        Below Next, select the text input field, there is a dropdown box to select the mode (see above).
            

            ===Inserting tags in wikitext===
            
            [[File:CountThings5.png|thumb|"countcharacters" tag in mode "All" on saved page]]
            
            In addition to using the visual editing mode, tags can be inserted using wikitext syntax as well. Use the following syntax when inserting tags directly in wikitextmode from the dropdown menu.
            

            While selecting the mode and page, a preview of the output is displayed. above the dialog box. If the page title in the table heading shows the page name in red ("redlink"), you have misspelled the page name and the page does not exist.
            

            ===Inserting tags in wikitext===
            
            If you add the tags in source code edit mode, use the following syntax.
        <pre>
        <bs:countarticles />
        <bs:countusers />
        <bs:countfiles />
        <bs:countcharacters mode="Words">ARTICLENAME</bs:countcharacters>
        </pre>
        

        For the "countcharacters" tag, replace ARTICLENAME with properthe page titlename for which you want to get the count values. Also, "mode" can be adjusted as needed. 
            For details, visit the reference page:
            
{{Box Links-en|Topic1=[[Reference:BlueSpiceCountThings]]}}
        

        {{Translation}}
Line 1: Line 1:
 
  
 
__TOC__
 
__TOC__
  
==What is BlueSpiceCountThings?==
+
==About 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
+
'''BlueSpiceCountThings''' introduces a set of tags for counting various metadata in the wiki. Available tags: countarticles, countusers, countfiles, and countcharacters.
*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
 
  
 
==Inserting tags==
 
==Inserting tags==
In order for information from this extension to be displayed on page, an editor must add desired tags on the page.
+
[[File:Manual:ve-magicword.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:ve-magicword.png|alt=Insert magic word|thumb|151x151px|Insert magic word]]
 
+
Tags are added through the "InsertMagic" dialog 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".<br />
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:Manual:VE-magicword-countarticles.png|alt=choosing a tag|center|thumb|450x450px|choosing a tag]]
  
{|
+
===Configuring the countcharacters tag===
|[[File:Checklist1.png|thumb]]
+
While other tags have no configuration options, and just adding them to the page is sufficient, the ''countcharacters'' tag must be configured.
|[[File:CountThings1.png|thumb]]
 
|}
 
  
===Configuring countcharacters tag===
+
After inserting this tag or clicking on an existing tag already on the page, a dialog  opens.
[[File:CountThings2.png|thumb]]
+
[[File:Manual:VE-magicword-countcharacterswords.png|alt=Count characters dialog box|center|thumb|600x600px|Count characters dialog box]]
While other tags have no configuration options, and just adding them to the page is sufficient, "countcharacters" tag must first be configured.
+
[[File:Manual:VE-magicword-countcharactersredlink.png|alt=Redlink page|thumb|180x180px|Redlink page]]
 +
Enter the  name of the page for which to count characters.
 +
This name should include the namespace if the page is not in the main namespace.
 +
Next, select the mode from the dropdown menu.
  
After inserting this tag, or clicking on existing tag already on the page, a dialog for configuration (inspector) will open.
+
While selecting the mode and page, a preview of the output is displayed. above the dialog box. If the page title in the table heading shows the page name in red ("redlink"), you have misspelled the page name and the page does not exist.
In this dialog, in the main text input field, the name of the page for which to count characters must be inserted.
 
This name should include the namespace in case the page is not in the main namespace.
 
Below the text input field, there is a dropdown box to select the mode (see above).
 
  
 
===Inserting tags in wikitext===
 
===Inserting tags in wikitext===
[[File:CountThings5.png|thumb|"countcharacters" tag in mode "All" on saved page]]
+
If you add the tags in source code edit mode, use the following syntax.
In addition to using the visual editing mode, tags can be inserted using wikitext syntax as well. Use the following syntax when inserting tags directly in wikitext.
 
 
<pre>
 
<pre>
 
<bs:countarticles />
 
<bs:countarticles />
Line 48: Line 32:
 
</pre>
 
</pre>
  
For the "countcharacters" tag, replace ARTICLENAME with proper page title. Also, "mode" can be adjusted as needed.
+
For the "countcharacters" tag, replace ARTICLENAME with the page name for which you want to get the count values. Also, "mode" can be adjusted as needed. For details, visit the reference page:
  
 
{{Box Links-en|Topic1=[[Reference:BlueSpiceCountThings]]}}
 
{{Box Links-en|Topic1=[[Reference:BlueSpiceCountThings]]}}
  
 
{{Translation}}
 
{{Translation}}

Attachments

Discussions