Some definitions

Elements

On sites module using, several elements are implemented in the VDoc base. From these elements we will keep the following:

  • ISite: site ;
  • ITopic: category containing pages,alias or sub-categories;
  • IPageContainer: page integrating several versions (draft or approved versions);
  • ISharedBlockContainer: shared block ;
  • IBlockTemplateContainer: blocks template ;
  • IContent: page version. This one contains a root block that,contains itself components and sub-blocks.
  • IBlock: part of a page containing components or sub-blocks.
  • IComponent: unit element that may be added to a block.

Diagram of elements classes

This classes diagram represents the main relations that exist between every classes of the site management system.

Element classes overview

Table of elements correspondence

Functional term Technical term SDK term Native term Description
Website Website ISite SiteImpl Element constituting a website
Category,folder Topic ITopic FolderImpl Element grouping pages,sub-categories,alias..
Page Page IPageContainer PageImpl Element constituting a page
Shared block Shared block ISharedBlockContainer CommonBlockImp Element constituting a shared block.
Block template Block template IBlockTemplateContainer TemplateImpl Element that may be re-used and configured inside several blocks or pages.
Contents of a page Content IContent ContentVersionImpl Element constituting a specific version of a page (ex.draft)
Block Block IBlock ContentVersionImpl Element composed of components and sub-blocks.
Component,element Component IComponent ElementImpl Unit element that may be added inside a block.

Programming tasks

This section describes some developments that are possible using SDK APIs of VDoc.

For clarity and to mark the different API levels, we have classified these developments into several sub-sections.

Summary tables of programming tasks

Category Programming tasks
General Using the SDK API site module Recovering a context to use the SDK API Using the transactions
Server Creating a site Recovering a site Deleting a site
Website Creating a category Recovering a category Recovering categories pf a site or a topic Creating a page Recovering a page Recovering pages of a site or a topic
Page Recovering the page content Recovering the main block of a page content Adding components to a page block Adding blocks to a page block Approving a Page
dynamic.html}Universal recipient Define a recipient Delete a named recipient Send a message to a named recipient Receive a sent message Position information for the site promotion from a page extension Position information for the site promotion from a plugin