A VWcms synopsis is a listing of site sections (pages) showing the title and an extract from the beginning of the section content.

There are four levels of synopsis

1	Lists the entire site (limited by parameters described below).
0	Lists everything at the directive level used. So an <H1> will synopsise all <H1>s. An <H2> will synposise all <H2>s until the next <H1> is encountered. Likewise, an <H3> will synopsise all <H3>s until the next <H2> or <H1> is encountered.
-1	Lists all immediate subordinate levels until the next peer level is encountered. So an <H1> will synposise all <H2> until the next <H1>, a <H2> all <H3>s until the next <H2>, while an <H3> will synopsise nothing.
-2	Will synopsise the subordinate of all immediate subordinates. In other words it only applies to <H1>s. A -2 will list all <H3>s until the next <H1> is encountered.

Parameters

The parameters are specified using the following keywords.

Parameter	Description
empty=	Optional message if synopsis is empty.
extract=	The length of the synopsis (number of characters). Values from 64 to 1023 are allowed.
level=	1, 0, -1, -2 (see above)
list=	The maximum number of items in the synopsis.
narrow	Collapses the layout of the synopsis/blog listing intended for narrow columns.
order=	"+" list is ascending date order (less recent at beginning) and "-" in descending order (more recent at beginning).
read=	The text or icon used in the link to the synopsised section.
since=	Lists only those section modified since the specified date or specified (negative) number of days, or "*" for all.
text=	A formal synopsis (see below). A formal synopsis may contain a maximum of 2048 characters.

Example 1

This example displays a synopsis of the rest of the sections at the same level as this one (second).

$$SYNOPSIS$level=0$$

BloggingThe $$BLOG$$ substitution directive allows simple weblogs to be supported. http://en.wikipedia.org/wiki/Blog The VWcms blog facility should not be thought of as just a mechanism for airing opinions[read]

RSS Feed"Really Simple Syndication" or "RDF Site Summary" is a means of providing timely and concise summaries of site content specifically for subscribers to that information. http://en.wikipedia.org/wiki[read]

TaggingA tag in a site or blog is a label that explicitly categorises site content. These can then be presented allowing a site user to select items of potential interest based on those categories. A word[read]

IconsAll VWcms substitution directives that produce navigation or other prompts on a rendered page have a textual default. For example, the navigation directives $$PREV$$, $$NEXT$$, $$BACK$$ and $$TOP$[read]

Conditional ContentThe $$IF$$ directive evaluates the request environment and then conditionally processes (and outputs) content between it and a matching $$ELSE$$ and/or $$ENDIF$$. Conditionals may be nested, and can[read]

Reserved SectionsThere are three reserved sections and titles. There is one other similar used during site editing. These do not appear in the table of content or site-map unless in management mode. $$LOGIN$$ This[read]

Example 2

This example displays a synopsis of the subordinate sections of this one, this time with a maximum 512 character extract.

$$SYNOPSIS$level=-1$extract=512$$

Example OneWikipedia redirects synopsis to: An abstract is a brief summary of a research article, thesis, review, conference proceeding or any in-depth analysis of a particular subject or discipline, and is often used to help the reader quickly ascertain the paper's purpose. When used, an abstract always appears at the beginning of a manuscript.[read]

Example TwoThis is a short example of a subordinate section for synopsis purposes.[read]

Example ThreeAnd Wiktionary describes synopsis as: Etymology From Late Latin synopsis, itself from Ancient Greek &sigma;&upsilon;&nu;&omicron;&psi;&iota;&sigmaf; (sunopsis) < &sigma;&upsilon;&nu; (sun), &ldquo;`with'&rdquo;) + &psi;&iota;&sigmaf; (opsis), &ldquo;`view'&rdquo;) Pronunciation (RP) IPA: /snpss/, SAMPA: /sI"nQpsIs/ (US) IPA: /snpss/, SAMPA: /sI"nA:psIs/ Audio (US)help, file Noun synopsis (plural synopses) A brief summary of the major points of a written work, either as prose or as a table; an abridgment or condensation[read]

Formal ExampleThis is an example of a formal synopsis. It is used in the listing as well as presented in the section.[read]

Change Synopsis

This example displays a synopsis the five most recently modified sections from the full site.

$$SYNOPSIS$level=1$order=-$list=5$since=*$$

Q&ASunday, 24 July 2011 22:40  (nearly 2 years ago)A question and answer challenge attempts to exclude automated spam generators by requiring additional input in the form of an answer to a question that is difficult for a machine to recognise as distinct[read]

Using Q&ASunday, 24 July 2011 22:22  (nearly 2 years ago)A question and answer challenge attempts to exclude automated spam generators by requiring additional input in the form of an answer to a question that is difficult for a machine to recognise as distinct[read]

Spam AbuseSunday, 24 July 2011 11:11  (nearly 2 years ago)Comment/feedback/form submission abuse may be from humans being a nuisance or malicious, or from spambots creating unwanted activity and site pollution. Although a notoriously difficult issue to address[read]

Reader CommentSunday, 24 July 2011 07:48  (nearly 2 years ago)Reader comment may be solicited and displayed using the $$COMMENT$$ substitution directive. JavaScript is required to view and make comments. When included on a page two buttons are displayed. The[read]

Using reCAPTCHAWednesday, 20 July 2011 21:46  (nearly 2 years ago)reCAPTCHA is a Google service that helps avoid automated ('bot) spam submission. A CAPTCHA is a program that can tell whether its user is a human or a computer. You've probably seen them - colorful[read]

Blog Synopsis

A blog listing is just a special case of site synopsis.  Different defaults but all the synopsis parameters are available to blog listings.

Formal Synopsis

By default a synopsis is performed by extracting the leading text of any section.  It is also possible to provide a formal synopsis that is used when presenting a list of synopses as well as being shown at the top of the section when accessed.

$$SYNOPSIS$text=This is an example of a formal synopsis. It is used in the listing as well as presented in the section.$$

See Formal Example for how it can be rendered.