Site Layout Editor

[srenault-meeds]

Rationale

Admins cannot edit layout of site while it can be useful to review the layout provided by default in order to:

• add app for footer, for newslist, etc. to be displayed in all pages of the site
• hide section of the layout
• manage differently the application in a topbar, in the sidebar, in the bottom bar

1. Functional Requirements

Top User Stories

Edit Site layout

Any site can be edited excepted the Meeds site and the global site.
If a site is listed in the sidebar, then it cannot be edited as well.
To edit the site layout, admins must access the sites management page.

Blank Site template

A blank site template must be provided so admins can start from zero and so, they can edit the layout at their convenience.
This blank site template will provide a layout with all 4 site sections provided:

• Side bar section (left one)
• Tob bar section
• Side bar section (right one)
• Bottom bar section

These site sections are specific to site layout edition. Indeed, they have their own particularities.
Of course, the admin can hide it using the global option

Site Section management

It is also possible to manage each section one by one.
Indeed, each section has its own characteristics:

• Side bar section (right or left)
  • Option to show it or not
  • If shown, then option to manage the max-width
  • Additionally, option to manage style: background and text
  • Only one column can be used to add application

• Bottom bar section
  • Option to show it or not
  • If shown, then option to manage the max-height and the number of columns so multiple apps can be added
  • Additionally, option to manage style: background and text

• Top bar section
  • Option to show it or not
  • If shown, then option to manage the max-height and the number of columns so multiple apps can be added
  • Option to make the topbar fixed when scrolling with options to manage background on scroll
  • Additionally, option to manage style: background and text

Addition of section

Sections can be added below the topbar or above the bottom bar
Each section added that way is a section we used to have when editing page.
That means we can use template section if needed.

Addition of Application

When adding an application in a site section,
Then it must be possible to manage its display as follow:

• Only one application by column can be added
• dragging the column to the right or to left adjust width of apps as well
• If topbar or bottom bar, editing the application provides new options to manage the width of the app and the alignement of content
  • Width management
    • Auto fill (default value)
    • Adjust to application content
    • Set a fixed width
      Precision: this choice will impact other applications added to the site section
  • Alignement management
    • Horizontal: Left / Center / Right
    • Vertical: Top / Middle / Bottom

Impacts

Gamification

NA

Notifications

NA

Analytics

NA

Unified Search

NA

2. Technical Requirements

Expected Volume & Performance

Security

The sites layout should be editable switch site edit permission property. All administrators should be able to edit any site layout even if not identified in the edit permission.

Extensibility

N/A

Configurability

The existing sites layout, predefined using XML, has to be updated in order to use the new Section Type definition.

Upgradability

The existing sites has to be upgraded to use the new site layout section definition. For Builtin sites, the upgrade has to be made automatically. But for the non-builtin sites, as for pages, when editing the site, a best effort migration should be made with a changes reminder and a sections list suggestion so that the administrator can relocate the applications manually.

Existing Features

The site templates layout has to be editable the same way for sites instances.

Feature Flags

N/A

Other Non Functional Requirements

N/A

3. Software Architecture

Security

The ACL algorithm of sites management will remain as is by allowing administrators to manage all sites in addition to the Site edit permission.

Access

• A new Site Editor portlet has to be added in order to manage Sites Section Types.
• The SiteLayoutRest has to evolve to allow retrieving Site Layout the same way the PageLayoutRest manages the page layouts.

Services & processing

• The Site layouts definition has to evolve in order to allow defining layouts using the new Section Types:
  • Sidebar section Type: to be used in Left and right sections of a site layout
  • Banner section Type: to be used in Top and Bottom containers

Data and persistence

N/A

[srenault-meeds]

@margondicco can you take a look at it please? Thanks

[margondicco]

Hello Go Fonc :-)

[boubaker]

Ready for tec spec review by DAO memebrs (eXo : @rdenarie )

[rdenarie]

Hello
Go tech