Selectiveindex

From MegaZine3
Jump to navigation Jump to search
{{#if: selectiveindex.jpg | }} {{#if: 2.1.3 | }}{{#if: gui/selectiveindex.asul
| }}{{#if: | }}
Plugin: Selectiveindex
Selectiveindex.jpg
Name Selectiveindex
Since version

2.1.3

Files

gui/selectiveindex.asul

Related plugins

The selectiveindex plugin outputs an overview of selected pages as a list of thumbnails in a popup window. Clicking a thumb will open that page in the book.

If the book has more than indexthumbsperpage pages, the next list of thumbs will be presented on the following page(s).

If the popup window is too small to show indexthumbsperpage thumbnails within the window, scrollbars for navigation within that window will be shown.


Settings

== indexthumbsperpage =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 25 |
  • Default: 25}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

The number of thumbnails shown on the first page. This is also used by the index plugins, i.e. both index and selectiveindex share this parameter.{{#if: |

  • See also: {{{see}}}}}

== indexdefault =={{#if: Bolean |

  • Type: Bolean}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: false |
  • Default: false}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Preset of page parameter index, i.e. by default no page is included in the list for the selective index but has to be set individually by page. If set to 'true', all pages will go into the selective index and those pages that should not show up must be declared by adding the attribute index with value 'false'{{#if: |

  • See also: {{{see}}}}}

Attributes

Element

== index =={{#if: Bolean |

  • Type: Bolean}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: indexdefault |
  • Default: indexdefault}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Depending on the settings of indexdefault

  • pages can be included in the list in setting the attribute index to true (in case of indexdefault is set to false)
  • pages can be excluded from the list in setting the attribute index to false (in case of indexdefault is set to true){{#if: |
  • See also: {{{see}}}}}

Examples

<book plugins="selectiveindex" indexthumbsperpage="20" indexdefault="false" >
    <chapter>
        <page>
            <img src="a.jpg" />
        </page>
        <page>
            <img src="b.jpg" />
        </page>
        <page index="true">
            <img src="c.jpg" />
        </page>
        <page>
            <img src="d.jpg" />
        </page>
    </chapter>
</book>

Only the 3rd page will be added to the list of thumbnails in the selective index.

MegaZine3 Plugin-related articles
Plugins Anchors · Background Sounds · Batchpages · Bookmarks · Console · ElementIDs · Gallery · Google Analytics · Help · JavaScript · Keyboard Navigation · Links · NavigationBar · Options · Overlays · Password · PDFLinks · Print · PrintPDF · SWFAddress· Search · Sidebar · Slideshow · Titles
Plugin Articles Writing a plugin · Writing a plugin II · Plugin development

{{#if: | |}}