• View
• Edit
• Upload
• History
• Print

SiteStructure

<< | Page list | >>

General structure of this site

• You are looking at a page (i.e. the page Site.SiteStructure).
• Each page belongs to a group (i.e. this page belongs to the group Site/).

The reason that lists of pages/groups are kept in a separate page is to make it easy to include these pages in other places such as overview maps.

Recomended "standard" pages

To maintain a recognizable structure over all of the site, here are some recomendations:

• Each group should contain a default page with the same name the group (e.g. the group Layouts/ also contains a page called Layouts.Layouts). This is the "homepage" of that group.
  • The default page of a group is a convenient place to put a description of the group.
  • And maybe also to point to (or include) a description of the pages within the group.
  • Please try and put a descriptive title on each page, since it will then be possible to use special markup to extract it (see LyX:SiteTest/IncludePara)
• Please use the page PageList in each group. For instance, when adding a page to a group, also add a link entry in the corresponding PageList. If this is done, the page that you added will automatically appear in the page GroupMap? (since that page includes the different PageList-pages).

Structure of SideBar

The sidebar is defined by a wiki page. Which page depends on the context of the current page as follows:

Structure of headers and footers

Typically a so called 'header' is inserted before all wiki pages at this site, unless the page contains a special directive. The contents of that header is taken from all of the following pages (assuming they exist):

• Site.GroupHeader-site — site specific header part.
• Field.GroupHeader-field? — field specific header part.
• <current-group>.GroupHeader? — group specific header part.

The 'footer' is similarly something that is inserted at the end of wiki pages. It's contents is taken from all of these pages (assuming they exist):

• Site.GroupFooter-site?
• Field.GroupFooter-field?
• <current-group>.GroupFooter?

The contents of the header at the time of writing this essentially achieves the following:

• Includes the part of Site.wikiStyles that defines site specific wiki styles
• Includes a wiki trail defined by <current-group>.PageList, assuming that page exists.

Important groups and pages for the site structure

Important groups:

• Site/ — Shared site group, where pages in this group are shared between all fields. Most pages common to the entire site should be stored in this group, e.g. the common part of the sidebar.
• <current-field>:Field — Field specific group, where pages common only to the current field should be stored, e.g. the field specific part of the sidebar.
• LyX:LyX/ — The main group in the user's field.
• Devel:Devel/ — The main group in the developer's field.

Important pages:

• Field.Field — Just a page for completeness so that the group has a home page. Typically it just refers to
• Sidebar pages (not all used)
  • Site.SideBar — Site common definition of the sidebar. Typically it includes the following pages:
    • Field.SideBar-field — The part of the sidebar that is specific to the current field.
    • Site.SharedGroups#list#listend — The part of the sidebar that lists the shared groups.
  • <current-group>.SideBar — Group specific definition of the sidebar. It replaces Site.SideBar if it exists.
• Site.SharedGroups — Explains and list the groups that are shared between fields at this site. Typically partially included by Site.SideBar.
• Site.SharedGroupsMap
• Site.Site
• Site.SiteMap
• Site.SiteStructure
• Field.AllRecentChanges — Field specific list of pages recently modified (automatically generated).
• <current-group>.RecentChanges — Group specific list of pages recently modified (automatically generated).
• <current-group>.PageList or <current-group>.Pages? — Lists pages in the current group together with a short teaser. The teaser is either manually written in the list, or automatically extracted from the various pages.
  If the page exists in the current group, it's used as a trail page by Site.GroupHeader-list? in the header.
• Header pages (not all are used)
  • Site.GroupHeader-site — Site specific header page
  • Field.GroupHeader-field? — Field specific header page
  • <current-group>.GroupHeader? — Group specific header page
• Footer pages (not all are used)
  • Site.GroupFooter-site? — Site specific footer page.
  • Field.GroupFooter-field? — Field specific footer page
  • <current-group>.GroupFooter? — Group specific footer page
• Site.WikiStyles — Site common page that defines and illustrates wiki styles useful at this site. This page is typically included by Site.GroupHeader-site. The actual style definitions must be placed withn the anchors #styles..#stylesend.
• ? pages
  • Site.Fields
  • Field.Groups
    • Field.GroupList?
  • Field.Overview
• Site.GroupList?
• Site.GroupMap?

Important anchors

• #styles...#stylesend — Delimits the part of Site.WikiStyles that contain definition of common wiki styles. Note that only style definitions and nothing else should be placed within these anchors.
• #list...#listend — Delimits a list of pages etc. Note that only list ites should be placed within these anchors. These anchors are used on pages such as Pages? to delimit the actual page list part of the page.
• — Defines the start of a line with teaser text on a page. It can be extracted using e.g. the teaser markup

T*SomePage?