Skip to content

Commit 03ef3fc

Browse files
committed
Tidy up the theming section
1 parent 7043d57 commit 03ef3fc

File tree

5 files changed

+89
-82
lines changed

5 files changed

+89
-82
lines changed
Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,69 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Plone Classic UI theming based on Barceloneta"
5+
"property=og:description": "Plone Classic UI theming based on Barceloneta"
6+
"property=og:title": "Plone Classic UI theming based on Barceloneta"
7+
"keywords": "Plone, Classic UI, theming, Barceloneta"
88
---
99

1010
(classic-ui-theming-barceloneta-label)=
1111

12-
# Plone Classic UI Theming Based on Barceloneta
12+
# Classic UI theming based on Barceloneta
1313

1414
```{todo}
1515
This page is only an outline and needs a lot of work.
16+
See https://github.com/plone/documentation/issues/1286
1617
```
1718

18-
* Use of SCSS
19-
* Colors, fonts and sizes via variable changeable
20-
* Properties for shadows, rounded corners, gradients.
21-
* `plonetheme.barceloneta` npm package for includes
22-
* `bobtemplates.plone` template
23-
* Theming is based on Twitter Bootstrap 5
24-
* We used Bootstrap markup in templates
25-
* We used Bootstrap components wherever possible
26-
* Most of the look and feel can be changed via Bootstrap's variables
27-
* Hint: order is important in SCSS
19+
- Use of SCSS
20+
- Colors, fonts, and sizes via variables is changeable
21+
- Properties for shadows, rounded corners, gradients.
22+
- `plonetheme.barceloneta` npm package for includes
23+
- `bobtemplates.plone` template
24+
- Theming is based on Twitter Bootstrap 5
25+
- We use Bootstrap markup in templates
26+
- We use Bootstrap components wherever possible
27+
- Most of the look and feel can be changed via Bootstrap's variables
28+
- Hint: order is important in SCSS
2829

2930

3031
(classic-ui-theming-barceloneta-theme-package-label)=
3132

32-
## Theme Package
33+
## Theme package
3334

34-
* Generated theme package can be uploaded as ZIP-file
35+
- Generated theme package can be uploaded as a .zip file.
3536

3637

3738
(classic-ui-theming-barceloneta-theme-structure-label)=
3839

39-
## Theme Structure
40+
## Theme structure
4041

4142
### `base.scss`
4243

43-
* Basices required for backend
44+
- Basics required for backend
4445

4546
### `barceloneta.scss`
4647

47-
* Barceloneta Theme basis
48+
- Barceloneta theme basics
4849

4950

50-
## npm Package
51+
## npm package
5152

52-
* npm package with files required for Plone
53-
* dependencies required by theme to compile
53+
- npm package with files required for Plone
54+
- dependencies required by theme to compile
5455

5556

56-
# Bootstrap Components
57+
## Bootstrap components
5758

58-
* Default components are extended with some custom components, such as a select or dropdown menu.
59-
* We use Boostrap variables in these cases.
59+
- Default components are extended with some custom components, such as a select or dropdown menu.
60+
- We use Boostrap variables in these cases.
6061

6162

62-
# Add-Ons and Templates
63+
## Add-ons and templates
6364

6465
Make life easy with...
6566

66-
* use Bootstrap markup
67-
* use Bootstrap components
68-
* use Bootstrap variables
67+
- use Bootstrap markup
68+
- use Bootstrap components
69+
- use Bootstrap variables

docs/classic-ui/theming/diazo.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Plone Classic UI theming with Diazo"
5+
"property=og:description": "Plone Classic UI theming with Diazo"
6+
"property=og:title": "Plone Classic UI theming with Diazo"
7+
"keywords": "Plone, Classic UI, theming, Diazo"
88
---
99

1010
(classic-ui-theming-diazo-label)=
1111

12-
# Plone Classic UI Theming with Diazo
12+
# Classic UI theming with Diazo
13+
14+
```{todo}
15+
This page is only an outline and needs a lot of work.
16+
See https://github.com/plone/documentation/issues/1286
17+
```
1318

1419
Theming based on Diazo.

docs/classic-ui/theming/from-scratch.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,44 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Plone Classic UI theming from scratch"
5+
"property=og:description": "Plone Classic UI theming from scratch"
6+
"property=og:title": "Plone Classic UI theming from scratch"
7+
"keywords": "Plone, Classic UI, theming, scratch"
88
---
99

1010
(classic-ui-theming-from-scratch-label)=
1111

12-
# Plone Classic UI Theming based on Barceloneta
12+
# Classic UI theming from scratch
1313

1414
```{todo}
1515
This page is only an outline and needs a lot of work.
16+
See https://github.com/plone/documentation/issues/1286
1617
```
1718

1819
Theming based on a filesystem package without any dependency.
1920

20-
* Theming for Plone 6 Classic UI
21-
* Theme stored in a filesystem package
22-
* Built from scratch
23-
* No dependencies to Barceloneta
24-
* No Diazo needed
21+
- Theming for Plone 6 Classic UI
22+
- Theme stored in a filesystem package
23+
- Built from scratch
24+
- No dependencies to Barceloneta
25+
- No Diazo needed
2526

2627

27-
## Theme Package
28+
## Theme package
2829

29-
* Create a theme package as explained here.
30-
* Remove what you do not need
31-
* Overrides
32-
* Static files
30+
- Create a theme package as explained here.
31+
- Remove what you do not need
32+
- Overrides
33+
- Static files
3334

3435

35-
## Static Files
36+
## Static files
3637

3738
Register directory to keep static files
3839

39-
File: src/plonetheme/munich/browser/configure.zcml
40-
Directory: src/plonetheme/munich/browser/static
40+
File: `src/plonetheme/munich/browser/configure.zcml`
41+
Directory: `src/plonetheme/munich/browser/static`
4142

4243
```xml
4344
<!-- Publish static files -->
@@ -52,8 +53,8 @@ Directory: src/plonetheme/munich/browser/static
5253

5354
### Manifest
5455

55-
* Manifest for your theme
56-
* Keep rules empty to disable Diazo
56+
- Manifest for your theme
57+
- Keep rules empty to disable Diazo
5758

5859
```ini
5960
[theme]
@@ -65,7 +66,7 @@ prefix = /++theme++plonetheme.munich
6566
doctype = <!DOCTYPE html>
6667
```
6768

68-
### Bundle Registration
69+
### Bundle registration
6970

7071
```xml
7172
<?xml version="1.0"?>
@@ -84,7 +85,7 @@ doctype = <!DOCTYPE html>
8485
</registry>
8586
```
8687

87-
### Theme Registration
88+
### Theme registration
8889

8990
Register your theme via theme.xml
9091

@@ -98,7 +99,7 @@ Register your theme via theme.xml
9899

99100
### Compile the bundle
100101

101-
* Compile SASS to SCSS
102+
- Compile SASS to SCSS
102103

103104
Install all requirements and dependencies from package.json:
104105

@@ -115,22 +116,21 @@ yarn dist
115116

116117
### Theming
117118

118-
* Make use of Bootstrap [variables](https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss)
119-
* Tweak basic settings like rounded corners, shadows, etc.
120-
* Set custom fonts
121-
* Define your own stuff
122-
* Import Boostrap (as basis)
119+
- Make use of Bootstrap [variables](https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss)
120+
- Tweak basic settings like rounded corners, shadows, and so on.
121+
- Set custom fonts
122+
- Define your own stuff
123+
- Import Boostrap (as basis)
123124

124125

125126
#### Templates
126127

127-
* Add z3c.jbot overrides
128-
* Copy Templates to customize
129-
* Add custom views for your story
128+
- Add `z3c.jbot` overrides
129+
- Copy templates to customize
130+
- Add custom views for your story
130131

131132

132-
### Available Themes
133+
### Available themes
133134

134-
* plonetheme.tokyo (mobile first, onw column)
135-
* plonetheme.munic (minimalistic)
136-
* plonetheme.berlin (based on Barceloneta)
135+
- [`plonetheme.tokyo`](https://github.com/collective/plonetheme.tokyo/) (mobile first, one column)
136+
- [`plonetheme.munich`](https://github.com/collective/plonetheme.munich/) (minimalistic)

docs/classic-ui/theming/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ myst:
44
"description": "Theming of Plone 6 Classic UI"
55
"property=og:description": "Theming of Plone 6 Classic UI"
66
"property=og:title": "Theming of Plone 6 Classic UI"
7-
"keywords": "Theming, Plone 6, Classic UI"
7+
"keywords": "Theming, Plone 6, Classic UI, Barceloneta, Diazo, scratch, through-the-web"
88
---
99

1010
(classic-ui-theming-index-label)=
1111

12-
# Theming of Plone 6 Classic UI
12+
# Theming of Classic UI
1313

1414
```{todo}
1515
This page is only an outline and needs a lot of work.
16+
See https://github.com/plone/documentation/issues/1286
1617
```
1718

1819
```{toctree}

docs/classic-ui/theming/through-the-web.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
4+
"description": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
5+
"property=og:description": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
6+
"property=og:title": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
77
"keywords": ""
88
---
99

1010
(classic-ui-through-the-web-label)=
1111

12-
# Through-the-web (TTW) Theme Customization in Plone 6 Classic UI
12+
# Through-the-web (TTW) theme customization
1313

1414
```{todo}
1515
This page is only an outline and needs a lot of work.
16+
See https://github.com/plone/documentation/issues/1286
1617
```
1718

1819
TTW customization is useful when you need to make small CSS changes.
@@ -22,7 +23,7 @@ Other theming methods should be used for larger customizations or entire website
2223

2324
(classic-ui-through-the-web-control-panels-label)=
2425

25-
## Control Panels
26+
## Control panels
2627

2728
You can make the following changes through control panels.
2829

@@ -44,7 +45,7 @@ Add screenshots.
4445

4546
(classic-ui-through-the-web-css-variables-label)=
4647

47-
## CSS Variables
48+
## CSS variables
4849

4950
Plone uses Twitter Bootstrap's CSS variables.
5051
They are used to tweak colors, fonts, spacing, and other CSS attributes.
@@ -54,10 +55,9 @@ Provide usage.
5455
```
5556

5657

57-
5858
(classic-ui-through-the-web-theming-control-panel-label)=
5959

60-
## Theming Control Panel
60+
## Theming control panel
6161

6262
The Theming control panel is limited to downloading and uploading themes.
6363

@@ -69,10 +69,10 @@ The Theming control panel is limited to downloading and uploading themes.
6969

7070
(classic-ui-through-the-web-restricted-python-label)=
7171

72-
### Restricted Python
72+
### Restricted python
7373

7474

7575
(classic-ui-through-the-web-content-types-label)=
7676

77-
### Content Types
77+
### Content types
7878

0 commit comments

Comments
 (0)