Description

• Requirement
• Need
• Notes
• Solutions
  • Solution 1
  • Solution 2
• Proposals
  • Solution 1
• Implementation proposal
  • Solution 1

Requirement

 Make discoverable the logo change feature

Need

• O: Logo change and basic configuration is one of the first task the evaluator would like to do (also because we claim that XWiki strength is personalization). Changing the logo + get access to the panel requires the knowledge + performing multiple clicks. Is doesn't give a feeling of . ease of use to the evaluator => these actions should be more straightforward
• O: For example using a hover on the logo or on the panel area an edit button could show up that is clickable and would bring you either to the place where you can perform the action or directly allow the action (for example change the logo)
• O: direct link to change the logo
• O: Hard to change the logo from the ColorTheme. Attachment zone doesn't give a success message, doesn't redirect back, page needs refresh

Notes

• Improve Administration description to include "logo" 
• Add attachment selector to CT
• Add logo preview in Skin

Solutions

Solution 1

Create a separate entry for Logo change in Administration.

Use cases needed:

UC1: I want to define a default logo so that when I create a new wiki, this logo is used by default
UC2: I want to define a default logo for a group of subwikis
UC3: I want to be able to define a custom logo for a given subwiki.
UC4: I want to be able to define a custom logo for a page + its children
UC5: I want to be able to define a custom logo for a single page

Here's the solution to implement UC1-5:

System Default logo (defined in the base skin on the FS)
  |_ System User-defined default system logo (Admin UI)
    |_ Wiki Skin logo (Skin)
      |_ Wiki Color Theme logo (CT)
        |_ Space Skin logo (Skin) (Future: Nested Page Skin logo)
          |_ Space Color Theme logo (Future: Nested Page CT logo)

The algorithm to choose which logo to display is the following:

• Is there a space color theme in use and does it define a custom logo? If so, use the logo
• Is there a space skin in use and does it define a custom logo? If so, use the logo
• Is there a wiki color theme in use and does it define a custom logo? If so, use the logo
• Is there a wiki skin in use and does it define a custom logo? If so, use the logo
• Is there a system default logo defined by the user? If so, use the logo
• Use the baseskin default logo from the FS.

Solution 2

Improve the CT logo process. Warning improved for 9.5

Proposals

Solution 1

Implementation proposal

Solution 1

• Introduce page XWiki.LogoConfig which will store the logo configuration
• Introduce class XWiki.LogoConfigClass with field logo which will store a reference to the attachment to be used as a logo
• Make the logo config editable in the Theme section of the administration as designed above
• Update companylogo.vm to use XWiki.LogoConfig when available before falling back to the system default logo