Show Me More Plugin - blojsom 3.0 - Confluence

Availability

blojsom 3.2

Description

The "More ..." plugin will truncate long entries and add a hyperlink to the description so that the user can view the full text of the entry.

Installation and Setup

In your /WEB-INF/classes/blojsom-plugins.xml file, add the following:

<bean id="show-me-more" class="org.blojsom.plugin.showmore.ShowMeMorePlugin" init-method="init" destroy-method="destroy"/>
    <bean id="show-me-more-admin" class="org.blojsom.plugin.showmore.admin.ShowMeMoreAdminPlugin"
          init-method="init" destroy-method="destroy">
        <property name="servletConfig">
            <ref bean="servletConfigFactoryBean"/>
        </property>
        <property name="authorizationProvider">
            <ref bean="authorizationProvider"/>
        </property>
        <property name="resourceManager">
            <ref bean="resourceManager"/>
        </property>
        <property name="fetcher">
            <ref bean="fetcher"/>
        </property>
    </bean>

You may then add "show-me-more" to one of the flavor-based plugin chains. The administration plugin will be available in the blojsom administration console under Plugins | Configure.

A user must have the following permissions in order to use the show-me-more administration plugin.

showmemore_admin_permission

Usage and URL Parameters

Properties

The following table describes the properties that control the operation of this plugin.

Property name	Default Value	Description
`entry-length-cutoff`	400	of characters before inserting a link to show the full text of the entry.
`entry-text-cutoff`		Text in an entry where a link will be inserted to show the full text of the entry. For example, `<more/>`
`show-me-more-text`		Text to be displayed in the link to display the full text of the entry.
`entry-text-cutoff-start`		Text where to start a link to display the full text of the entry. This allows you to cut out just a portion of a large entry. For example, `<cut>`
`entry-text-cutoff-end`		Text where to end the cut of a portion of a large entry. For example, `</cut>`

URL Parameters

The following table describes the URL parameters that affect the output of the "more ..." plugin.

URL parameter	Accepted values	Usage
smm	If "smm" is set to "y", the plugin will not be executed on entries. This is used when generating the link to the entry with the full description.	/blog/?smm=y