Documentation

Brand: Twinpictures Plugin Oven | Category: WordPress Plugin | Author: Baden Coleman
Updated: 22 December, 2016

Collapse-Pro-Matic VS. Collapse-O-Matic

The Collapse-Pro-Matic plugin replaces the free Collapse-O-Matic. Therefore it is recommended that if Collapse-O-Matic has been installed, it be de-activated before installing Collapse-Pro-Matic. The collapse elements and page option settings will transfer to the pro version.

Plugin Registration

To receive plugin updates Collapse-Pro-Matic must be registered using a licence key. Licence keys may be viewed and managed by logging into your account.

Options Page

Collapse-Pro-Matic Options Page

Collapse-Pro-Matic Options Page

Collapse-Pro-Matic has an expanded list of global options located under the Dashboard > Settings > Collapse-Pro-Matic. This options page controls the global settings for all Collapse Elements used on the site.

Style

The Style option selects which css style to load. See Collapse-O-Matic Style for a more detailed description.

Tag Attribute

Default HTML tag use to wrap the trigger text. See the Collapse-O-Matic Tag Attribute for more details.

Offset Attribute

Default offset value for both the Findme Attribute and URL anchors. Both positive and negative numbers may be used to offset the scroll amount to leave room for sticky menus at the top of the page.

Wrap Tag Attribute

Default HTML tag use to wrap the entire collapse element. See Elwraptag Attribute in the Collapse-O-Matic documentation for more info.

Wrap Class Attribute

Default class used to wrap the entire collapse element. See Elwrapclass Attribute in the Collapse-O-Matic documentation for more info.

Targtag Attribute

Default HTML tag to use for the target element. See Targtag Attribute in the Collapse-O-Matic documentation for more info.

Trigpos Attribute

Default positioning of the title trigger above or below the target. See Trigpos Attribute in the Collapse-O-Matic documentation for more info.

Targpos Attribute

Default positioning of the target as an inline or block element. See Targpos Attribute in the Collapse-O-Matic documentation for more info.

Collapse/Expand Duration

A string or number determining how long the animation will run. Durations are given in milliseconds; higher values indicate slower animations, not faster ones. See Collapse-O-Matic Duration for more details.

Animation Effect

Animation effect to use while collapsing and expanding. See Collapse-O-Matic Animation Effect for a more detailed description of this option.

Cookie Expires

How many days before cookie expires. If the cookeiname attribute is set, then the expand/collapse state of each element will be stored in a cookie for each user. This is a useful feature if the expand/collapse sate should not be cleared and revert to default when the page is reloaded, such as during page navigation and return visits.

Nested Sub Expands

How many nested subexpand levels to include with the plugin. In the unlikely event that more than 30 sub-levels of nested collapses are needed: here is where more (or better: less) can be defined when the plugin initiates. If more than 30 nested sub expands are needed, it might be time to consult a doctor and seek professional help.

Custom Style

Custom CSS style for ultimate flexibility! Any custom css definitions used for this plugin should be added here instead of modifying the theme’s style.css file.

Shortcode Loads Scripts

If this option is checked then the Collapse-Pro-Matic JavaScript files will only load on posts and pages that actually use the [expand] shortcode. If the roll-your-own method is used to create the expand elements, be sure that this box is left un-checked so that the script loads on every page.

Script Load Location

By default, the plugin will load all required scripts in the footer. This is the current recommended practice as it helps pages load faster. However, there are cases where it is preferred that the script loads in the header. Use this option to tell the plugin where to load the script: either in the Header or the Footer. Pretty straight forward stuff, that.

Shortcode

All shortcode options used in Collapse-O-Matic are also available in the pro version. Below are the extra features included in Collapse-Pro-Matic version only.

Cookiename Attribute

The cookiename attribute should be set to a unique name that is used to save the collapse element state. How long this state ‘lives’ in the cookie is determined by the Cookie Expires value that is set under the Options Page: Dashboard > Settings > Collapse-Pro-Matic. The default is 7 days.
[expand title="Trigger Text" cookiename="monkey"]Content[/expand]

Trigger Text

You might think you can catch a monkey, but you can not. Monkeys are fast!

Swapalt Attribute

Use the swapalt attribute to assign alternate alt and title attributes of the expand element when swaptitle is used.
[expand title="On" swaptitle="Off" swapalt="Turn off the lights!"]Target Content[/expand]

On

The light is bright. Oh so very bright.

Expand On Attribute

Use the expand_on attribute assign a comma separated list of WordPress Conditional Tags that will auto-expand the element if true. Custom created JavaScript functions that return true/false can also be used as a value for this attribute.
[expand title="Trigger Text" expand_on="is_single, is_search"]Target Text[/expand]
The following element should be displayed as collapsed when viewing the front (blog) page, but when viewing the single post or the search results page it will be shown as expanded.

Trigger Text

Target Text

Multiple Triggers

To add extra targets, the additional trigger ID is format of extra-id using the roll-your-own method like so:
<div class="collapseomatic" id="twins">trigger 1</div>
<div id="target-twins" class="collapseomatic_content">content</div>
<div class="collapseomatic" id="extra-twins">trigger 2</div>

which will produce the following:

trigger 1
In German, the twins are known as Die Zwillinge
trigger 2

Multiple Targets

To add extra targets, assign the ID in the format of target[n]-id using the roll-your-own method as follows:
<div id="target1-monkey" class="collapseomatic_content">content</div>
<div id="monkey" class="collapseomatic">Trigger</div>
<div id="target2-monkey" class="collapseomatic_content">content</div>

which should produce a little something like:

You might think you can catch a monkey, but you can’t. Monkeys are FAST!
Trigger
You might still think you can catch a monkey, but you really can’t. Monkeys are still FAST!

Offset Attribute

The offset attribute is used in combination with the findme attribute and will offset the amount of scroll up or down using either a positive or negative value.
[expand title="Stars" findme="auto" offset="200"]Target Content[/expand]
[expand title="Constellations" findme="auto" offset="-200" ]Target Content[/expand]

Stars

ACAMAR
ACHERNAR
Achird
ACRUX
Acubens
ADARA
Adhafera
Adhil
AGENA
Ain al Rami
Ain
Al Anz
Al Kalb al Rai
Al Minliar al Asad
Al Minliar al Shuja
Aladfar
Alathfar
Albaldah
Albali
ALBIREO
Alchiba
ALCOR
ALCYONE
ALDEBARAN
ALDERAMIN
Aldhibah
Alfecca Meridiana
Alfirk
ALGENIB
ALGIEBA
ALGOL
Algorab
ALHENA
ALIOTH
ALKAID
Alkalurops
Alkes
Alkurhah
ALMAAK
ALNAIR
ALNATH
ALNILAM
ALNITAK
Alniyat
Alniyat
ALPHARD
ALPHEKKA
ALPHERATZ
Alrai
Alrisha
Alsafi
Alsciaukat
ALSHAIN
Alshat
Alsuhail
ALTAIR
Altarf
Alterf
Aludra
Alula Australis
Alula Borealis
Alya
Alzirr
Ancha
Angetenar
ANKAA
Anser
ANTARES
ARCTURUS
Arkab Posterior
Arkab Prior
ARNEB
Arrakis
Ascella
Asellus Australis
Asellus Borealis
Asellus Primus
Asellus Secondus
Asellus Tertius
Asterope
Atik
Atlas
Auva
Avior
Azelfafage
Azha
Azmidiske
Baham
Baten Kaitos
Becrux
Beid
BELLATRIX
BETELGEUSE
Botein
Brachium
CANOPUS
CAPELLA
Caph
CASTOR
Cebalrai
Celaeno
Chara
Chort
COR CAROLI
Cursa
Dabih
Deneb Algedi
Deneb Dulfim
Deneb el Okab
Deneb el Okab
Deneb Kaitos Shemali
DENEB
DENEBOLA
Dheneb
Diadem
DIPHDA
Double Double (7051)
Double Double (7052)
Double Double (7053)
Double Double (7054)
Dschubba
Dsiban
DUBHE
Ed Asich
Electra
ELNATH
ENIF
ETAMIN
FOMALHAUT
Fornacis
Fum al Samakah
Furud
Gacrux
Gianfar
Gienah Cygni
Gienah Ghurab
Gomeisa
Gorgonea Quarta
Gorgonea Secunda
Gorgonea Tertia
Graffias
Grafias
Grumium
HADAR
Haedi
HAMAL
Hassaleh
Head of Hydrus
Herschel’s “Garnet Star”
Heze
Hoedus II
Homam
Hyadum I
Hyadum II
IZAR
Jabbah
Kaffaljidhma
Kajam
KAUS AUSTRALIS
Kaus Borealis
Kaus Meridionalis
Keid
Kitalpha
KOCAB
Kornephoros
Kraz
Kuma
Lesath
Maasym
Maia
Marfak
Marfak
Marfic
Marfik
MARKAB
Matar
Mebsuta
MEGREZ
Meissa
Mekbuda
Menkalinan
MENKAR
Menkar
Menkent
Menkib
MERAK
Merga
Merope
Mesarthim
Metallah
Miaplacidus
Minkar
MINTAKA
MIRA
MIRACH
Miram
MIRPHAK
MIZAR
Mufrid
Muliphen
Murzim
Muscida
Muscida
Muscida
Nair al Saif
Naos
Nash
Nashira
Nekkar
NIHAL
Nodus Secundus
NUNKI
Nusakan
Peacock
PHAD
Phaet
Pherkad Minor
Pherkad
Pleione
Polaris Australis
POLARIS
POLLUX
Porrima
Praecipua
Prima Giedi
PROCYON
Propus
Propus
Propus
Rana
Ras Elased Australis
Ras Elased Borealis
RASALGETHI
RASALHAGUE
Rastaban
REGULUS
Rigel Kentaurus
RIGEL
Rijl al Awwa
Rotanev
Ruchba
Ruchbah
Rukbat
Sabik
Sadalachbia
SADALMELIK
Sadalsuud
Sadr
SAIPH
Salm
Sargas
Sarin
Sceptrum
SCHEAT
Secunda Giedi
Segin
Seginus
Sham
Sharatan
SHAULA
SHEDIR
Sheliak
SIRIUS
Situla
Skat
SPICA
Sterope II
Sualocin
Subra
Suhail al Muhlif
Sulafat
Syrma
Tabit (1543)
Tabit (1544)
Tabit (1552)
Tabit (1570)
Talitha
Tania Australis
Tania Borealis
TARAZED
Taygeta
Tegmen
Tejat Posterior
Terebellum
Terebellum
Terebellum
Terebellum
Thabit
Theemim
THUBAN
Torcularis Septentrionalis
Turais
Tyl
UNUKALHAI
VEGA
VINDEMIATRIX
Wasat
Wezen
Wezn
Yed Posterior
Yed Prior
Yildun
Zaniah
Zaurak
Zavijah
Zibal
Zosma
Zuben Elakrab
Zuben Elakribi
Zuben Elgenubi
Zuben Elschemali

Constellations

Andromeda
Antlia
Apus
Aquarius
Aquila
Ara
Aries
Auriga
Bo├Âtes
Caelum
Camelopardalis
Cancer
Canes Venatici
Canis Major
Canis Minor
Capricornus
Carina
Cassiopeia
Centaurus
Cepheus
Cetus
Chamaeleon
Circinus
Columba
Coma Berenices
Corona Austrina
Corona Borealis
Corvus
Crater
Crux
Cygnus
Delphinus
Dorado
Draco
Equuleus
Eridanus
Fornax
Gemini
Grus
Hercules
Horologium
Hydra
Hydrus
Indus
Lacerta
Leo
Leo Minor
Lepus
Libra
Lupus
Lynx
Lyra
Mensa
Microscopium
Monoceros
Musca
Norma
Octans
Ophiuchus
Orion
Pavo
Pegasus
Perseus
Phoenix
Pictor
Pisces
Piscis Austrinus
Puppis
Pyxis
Reticulum
Sagitta
Sagittarius
Scorpius
Sculptor
Scutum
Serpens
Sextans
Taurus
Telescopium
Triangulum
Triangulum Australe
Tucana
Ursa Major
Ursa Minor
Vela
Virgo
Volans
Vulpecula

Special Classes

There are a number of special classes that can be assigned using either the trigclass or targclass attributes. All special classes are listed in the table below.

Class Name Assigned By Use
arrowright trigclass places expand/collapse arrows to the right of trigger text
noarrow trigclass removes the expand/collapse arrows
colomat-expand-only trigclass expand elements can be expanded only once and then will remain locked open
maptastic targclass The target content area will not be hidden initially but rather placed off screen to allow other shortcodes such as google maps to render.
setall trigclass Assign this class to any trigger and it will act as an expand/collapse all toggle for all other expand elements on the page.

Callbacks

v1.0.8 Callbacks

v1.0.8 Callbacks

As of version 1.0.8 three new callbacks can be set in the plugin option page. Simply enter the jQuery or JavaScript function that is to be triggered by the following events:
Expand Callback is fired when any element is expanded.
Collapse Callback is fired when any element is collapsed.
Expand/Collapse Callback is fired when any element is, you guessed it, expanded or collapsed.