Discussion

Difference between revisions of "Reference:BlueSpiceBookshelf"

(→‎User manual)
(Tag: 2017 source edit)
 

Extension: BlueSpiceBookshelf


Overview
Description: enables you to combine different wiki articles to create books and also to export those as a pdf documentEnables BlueSpice to manage and export hierarchical collections of articles.
State: stable Dependency: BlueSpice
Developer: HalloWelt License:

GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.

Type: BlueSpice Category: Book
Edition: BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
View help page

Features

[edit source]Bookshelf is an extension of the package BlueSpice Bookmaker. Bookshelf enables you to combine different wiki articles

Description[edit | edit source]

Bookshelf combines wiki pages to create books and also to export those pages as a

pdf

PDF document.

Usage/ Features[edit | edit source]
  • Sets of different
chapters / articles / documents
  • pages (chapters) can be put together individually to a book.
  • The table of contents of the book is displayed in the
upper right of the standardThere is a "Next" and "Back" button to navigate between the chapters
  • left navigation bar.
  • The chapters are displayed in a collapsible tree structure.
  • Click on a chapter heading to navigate to it.
    • Configuration[edit | edit source]
    • The book or parts of the book can be exported to PDF.

    Technical information[edit | edit source]

    Configuration manager

    Some aspects of this extension can be configured on Special:

    BlueSpicePreferences, under section "Bookshelf"

    BlueSpiceConfigManager. Here, wiki administrators can

    configure following

    :

    Prepend
    • prepend the article table of contents and headlines of a page with book
    numberation
    • numeration.
    Supress
    • supress the namespace prefix of book articles in the PDF output.
    Use
    • apply the display title from the book source
    on articleRights (permissions)[edit | edit
    • to a wiki page.

    Technical Information[edit source]

    The right to create a book depends on "edit" permission in the "Book" namespace

    This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

    Requirements[edit

    | edit User manual[edit |

    This extension requires BlueSpiceFoundation.

    • MediaWiki: 1.31
    • BlueSpiceFoundation: 3.1

    Integrates into[edit source]

    • BlueSpiceBookshelf

    Special pages[edit source]

    For detailed description and usage please visit our user manual.

    Try free our BlueSpice[edit | edit source]

    BlueSpice Demo.

    • Bookshelf
    • BookshelfBookEditor
    • BookshelfBookManager

    Permissions[edit source]

    Name Description Role
    bookshelf-viewspecialpage Access the special page Special:Bookshelf reader
    bookshelfbookmanager-viewspecialpage Access the special page Special:BookshelfBookManager reader

    Configuration[edit source]

    Name Value
    BookShelfDefaultCoverImage 'resources/images/assets/coverimage/dummy.png'
    BookShelfShowChapterNavigationPagerAfterContent false
    BookShelfShowChapterNavigationPagerBeforeContent false
    BookshelfPrependPageTOCNumbers true
    BookshelfSupressBookNS true
    BookshelfTitleDisplayText true

    User options[edit source]

    Name Value
    bs-bookshelf-defaultview 'gridviewpanel'

    API Modules[edit source]

    • bs-bookshelf-bookstore
    • bs-bookshelf-manage
    • bs-bookshelf-mass-add-page-store
    • bs-bookshelf-page-collection-store
    • bs-bookshelf-store

    Hooks[edit source] 

    {{BSExtensionInfoboxBSExtensionInfo
        
        |desc=enables you to combine different wiki articlesCombines wiki pages to create books and also to export those pages as a pdfPDF document.
        
        |status=stable
        
        |developer=HalloWelt
        
        |type=BlueSpice
        
        |edition=BlueSpice pro
            
            |active=Yes
            
            |compatible=BlueSpice
            
            |package=Bookmaker
            
            |category=Book
            
            }}
            
            __TOC__
            
            
            
            ==Description==
            
            
            
            '''Bookshelf''' is an extension of the package [[Bookmaker|BlueSpice Bookmaker]]. Bookshelf enables you to combine different wiki articles, BlueSpice Farm, BlueSpice Cloud
            
            |compatible=BlueSpice
            
            |category=Book
            
            |license=GPL v3 only
            
            |features=
            
            '''Bookshelf''' combines wiki pages to create books and also to export those pages as a pdfPDF document.
        
        
        
        
        ==Usage/ Features==
            
            
            
            * Sets of different chapters / articles / documents *Sets of different pages (chapters) can be put together individually to a book.
        
        * The table of contents of the book is displayed in the upper right of the standard.
            
            * left navigation bar.
            
            *The chapters are displayed in a collapsible tree structure.
        
        * Click on a chapter heading to navigate to it.
            
            * There is a "Next" and "Back" button to navigate between the chapters of the book.
            
            
            
            ==Technical information==
            
            
            
            ===Configuration===The book or parts of the book can be exported to PDF.
            
            
            
            ===Configuration manager===
        
        Some aspects of this extension can be configured on [[<code>Special:BlueSpicePreferences]], under section "Bookshelf". Here wiki administrators can configure following:
            
            
            
            * PrependBlueSpiceConfigManager</code>. Here, wiki administrators can:
            
            
            
            *prepend the article table of contents and headlines with book numberation
            
            * Supressof a page with book numeration.
            
            *supress the namespace prefix of book articles in the PDF output
            
            * Use.
            
            *apply the display title from the book source on article
            
            
            
            ===Rights (permissions)===
            
            The right to create a book depends on "edit" permission in the "Book" namespace.
            
            
            
            ===Requirements===
            
            
            
            This extension requires [[BlueSpiceFoundation]].
            
            
            
            ==User manual==
            
            For detailed description and usage please visit our [[Manual:Extension/Bookshelf|user manual]].
            
            
            
            ==Try free our BlueSpice==
            
            [https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.]
            
            
            
            
            
            [[de:{{FULLPAGENAME}}]][[en:{{FULLPAGENAME}}]]
            
            [[Category:Extension]]to a wiki page.
            
            
            
            }}
    (16 intermediate revisions by 4 users not shown)
    Line 1: Line 1:
    −
    {{BSExtensionInfobox
    		+
    {{BSExtensionInfo
    −
    |desc=enables you to combine different wiki articles to create books and also to export those as a pdf document.
    		+
    |desc=Combines wiki pages to create books and also to export those pages as a PDF document.
     
    |status=stable
    		 
    |status=stable
     
    |developer=HalloWelt
    		 
    |developer=HalloWelt
     
    |type=BlueSpice
    		 
    |type=BlueSpice
    −
    |edition=BlueSpice pro
    		+
    |edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
    −
    |active=Yes
    		 
     
    |compatible=BlueSpice
    		 
    |compatible=BlueSpice
    −
    |package=Bookmaker
    		 
     
    |category=Book
    		 
    |category=Book
    −
    }}
    		+
    |license=GPL v3 only
    −
    __TOC__
    		+
    |features=
     +
    '''Bookshelf''' combines wiki pages to create books and also to export those pages as a PDF document.
      
    −
    ==Description==
    		+
    *Sets of different pages (chapters) can be put together individually to a book.
     +
    *The table of contents of the book is displayed in the left navigation bar.
     +
    *The chapters are displayed in a collapsible tree structure.
     +
    *The book or parts of the book can be exported to PDF.
      
    −
    '''Bookshelf''' is an extension of the package [[Bookmaker|BlueSpice Bookmaker]]. Bookshelf enables you to combine different wiki articles to create books and also to export those as a pdf document.
    		+
    ===Configuration manager===
     +
    Some aspects of this extension can be configured on <code>Special:BlueSpiceConfigManager</code>. Here, wiki administrators can:
      
    −
    ==Usage/ Features==
    		+
    *prepend the article table of contents and headlines of a page with book numeration.
     +
    *supress the namespace prefix of book articles in the PDF output.
     +
    *apply the display title from the book source to a wiki page.
      
    −
    * Sets of different chapters / articles / documents can be put together individually to a book.
    		+
    }}
    −
    * The table of contents of the book is displayed in the upper right of the standard.
    		 
    −
    * The chapters are displayed in a collapsible tree structure.
    		 
    −
    * Click on a chapter heading to navigate to it.
    		 
    −
    * There is a "Next" and "Back" button to navigate between the chapters of the book.
    		 
    −
     
    		 
    −
    ==Technical information==
    		 
    −
     
    		 
    −
    ===Configuration===
    		 
    −
    Some aspects of this extension can be configured on [[Special:BlueSpicePreferences]], under section "Bookshelf". Here wiki administrators can configure following:
    		 
    −
     
    		 
    −
    * Prepend article table of contents and headlines with book numberation
    		 
    −
    * Supress namespace prefix of book articles in output
    		 
    −
    * Use display title from book source on article
    		 
    −
     
    		 
    −
    ===Rights (permissions)===
    		 
    −
    The right to create a book depends on "edit" permission in the "Book" namespace.
    		 
    −
     
    		 
    −
    ===Requirements===
    		 
    −
     
    		 
    −
    This extension requires [[BlueSpiceFoundation]].
    		 
    −
     
    		 
    −
    ==User manual==
    		 
    −
    For detailed description and usage please visit our [[Manual:Extension/Bookshelf|user manual]].
    		 
    −
     
    		 
    −
    ==Try free our BlueSpice==
    		 
    −
    [https://en.demo.bluespice.com/wiki/Main_Page BlueSpice Demo.]
    		 
    −
     
    		 
    −
     
    		 
    −
    [[de:{{FULLPAGENAME}}]][[en:{{FULLPAGENAME}}]]
    		 
    −
    [[Category:Extension]]
    		 
    Retrieved from "https://bs3-en.wiki.bluespice.com/w/index.php?title=Reference:BlueSpiceBookshelf&oldid=26334"

    Attachments

    Discussions