root/cpsskins/branches/paris-sprint-2006/doc/theme-structure.txt

=======================
THEME MANAGEMENT FOLDER
=======================

Themes are located inside a Theme Management Folder.

The folder structure is::

 + themes ( .../++etc++site/defaut/themes )
 |
 +--- Theme A
 |  |
 |  + page a
 |
 |
 +--+ Theme B
 |  |
 |  + page a
 |  |
 |  + page b
 |
 |
 + Portlets (local)
 |
 + Formats (styles, layouts, ...)
 |
 + Images (backgrounds, icons, ...)
 |
 + Presets
 |
 + Snapshots
 |
 + Locations

Setup:

    >>> root = getRootFolder()

    >>> from cpsskins.tests.setup import addThemeManager
    >>> from cpsskins.tests.setup import makeSite
    >>> from cpsskins.utils import addThemeSkeleton

    >>> tmutil = addThemeManager(root, makeSite(root))

    >>> def inspect():
    ...     for theme in tmutil.getThemes():
    ...         print '- %s (default: %s)' % (theme.title,
    ...                                       tmutil.isDefault(theme))
    ...         for page in theme.getPages():
    ...             print '  |_ %s (default: %s)' % \
    ...                 (page.title, tmutil.isDefault(page))


We add a theme skeleton, this creates a default theme with a default page.

    >>> theme1 = addThemeSkeleton(tmutil)

    >>> inspect()
    - Theme (default: True)
      |_ ThemePage (default: True)

    >>> tmutil.getDefaultTheme()
    Theme('Theme')

we create and add a second theme:

    >>> from cpsskins.elements.theme import Theme
    >>> theme2 = Theme(u'Theme 2')

    >>> tmutil.addTheme(theme2)
    u'Theme-2'

    >>> inspect()
    - Theme (default: True)
      |_ ThemePage (default: True)
    - Theme 2 (default: False)

the default theme is still the first theme:

    >>> tmutil.getDefaultTheme()
    Theme('Theme')

    >>> theme1.isDefault(), theme2.isDefault()
    (True, False)

themes have siblings:

    >>> theme2.getSiblings()
    [Theme('Theme')]

    >>> theme1.getSiblings()
    [Theme('Theme 2')]

a theme has pages:

    >>> theme1.getPages()
    [ThemePage('ThemePage')]

we create and add a page to the second theme:

    >>> from cpsskins.elements.themepage import ThemePage
    >>> page1 = ThemePage('Page 1')
    >>> tmutil.addPage(theme2, page1)
    'ThemePage'

    >>> inspect()
    - Theme (default: True)
      |_ ThemePage (default: True)
    - Theme 2 (default: False)
      |_ Page 1 (default: True)

we add a second page to the second theme:

    >>> page2 = ThemePage('Page 2')
    >>> tmutil.addPage(theme2, page2)
    u'ThemePage-2'

    >>> inspect()
    - Theme (default: True)
      |_ ThemePage (default: True)
    - Theme 2 (default: False)
      |_ Page 2 (default: False)
      |_ Page 1 (default: True)

pages have siblings:

    >>> page1.getSiblings()
    [ThemePage('Page 2')]

    >>> page2.getSiblings()
    [ThemePage('Page 1')]

we can set the second theme as the default theme:

    >>> tmutil.setAsDefault(theme2)
    >>> inspect()
    - Theme (default: False)
      |_ ThemePage (default: True)
    - Theme 2 (default: True)
      |_ Page 2 (default: False)
      |_ Page 1 (default: True)

we can set the second page as the default page:

    >>> tmutil.setAsDefault(page2)
    >>> inspect()
    - Theme (default: False)
      |_ ThemePage (default: True)
    - Theme 2 (default: True)
      |_ Page 2 (default: True)
      |_ Page 1 (default: False)


if we remove a page that was used by default, the first page of the theme
will be use by default instead:

    >>> del theme2[u'ThemePage-2']

    >>> inspect()
    - Theme (default: False)
      |_ ThemePage (default: True)
    - Theme 2 (default: True)
      |_ Page 1 (default: True)

we can also remove the only page of a theme:

    >>> del theme2[u'ThemePage']

    >>> inspect()
    - Theme (default: False)
      |_ ThemePage (default: True)
    - Theme 2 (default: True)

if we remove a theme that is a default theme, the first theme will become
the default theme:

    >>> del tmutil[u'Theme-2']
    >>> inspect()
    - Theme (default: True)
      |_ ThemePage (default: True)

we can delete the only theme left:


    >>> del tmutil[u'Theme']
    >>> inspect()