Skip to content

Commit 64e9f53

Browse files
committed
Clean up outlines of theming files
Update index for structure Fix Sphinx warnings and errors
1 parent dbacd96 commit 64e9f53

File tree

11 files changed

+77
-62
lines changed

11 files changed

+77
-62
lines changed

docs/classic-ui/icons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This provides an option to customize the contenttype and Plone UI icons by overr
3434
- [Plone UI](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_plone.xml)
3535

3636

37-
(classic-ui-icons-registration-label)=
37+
(classic-ui-icons-contextual-icons-label)=
3838

3939
## Contextual Icons
4040

docs/classic-ui/index.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Plone Classic UI
44

55
```{todo}
6-
Perhaps some of this introduction should be an include, so we don't have to repear ourselves?
6+
Perhaps some of this introduction should be an include, so we don't have to repeat ourselves?
77
```
88

99
Plone 6 ships with two user interfaces or frontends.
@@ -40,23 +40,14 @@ This chapter is a developer reference manual for working with Classic UI.
4040
:maxdepth: 2
4141
4242
static-resources
43-
theming
43+
theming/index
4444
templates
4545
views
4646
viewlets
4747
forms
4848
portlets
4949
csrf
50-
through-the-web
51-
whatsnew
52-
53-
bodyclasses
5450
icons
55-
registry/index
56-
theming/barceloneta/index
57-
theming/diazo/index
58-
theming/from-scratch/index
59-
theming/index
60-
theming/theme-package/index
61-
theming/ttw/index
51+
recipes
52+
whatsnew
6253
```

docs/classic-ui/theming.md

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,59 @@
1-
# Plone Classic UI Theming based on Barceloneta
1+
(classic-ui-theming-barceloneta-label)=
2+
3+
# Plone Classic UI Theming Based on Barceloneta
4+
5+
```{todo}
6+
This page is only an outline and needs a lot of work.
7+
```
28

39
* Use of SCSS
4-
* Colors, fonts and sizes via variable changable
5-
* Properties for shadows, rounded corners, gradients, etc.
6-
* plonetheme.barceloneta npm package for includes
7-
* bobtemplates.plone template
8-
* Theming is based on Bootstrap 5
10+
* Colors, fonts and sizes via variable changeable
11+
* Properties for shadows, rounded corners, gradients.
12+
* `plonetheme.barceloneta` npm package for includes
13+
* `bobtemplates.plone` template
14+
* Theming is based on Twitter Bootstrap 5
915
* We used Bootstrap markup in templates
1016
* We used Bootstrap components wherever possible
11-
* Most of look and feel can be touched via Bootstrap's variables
17+
* Most of the look and feel can be changed via Bootstrap's variables
1218
* Hint: order is important in SCSS
1319

1420

15-
# Theme Package
21+
(classic-ui-theming-barceloneta-theme-package-label)=
22+
23+
## Theme Package
1624

1725
* Generated theme package can be uploaded as ZIP-file
1826

1927

20-
# Theme Structure
28+
(classic-ui-theming-barceloneta-theme-structure-label)=
29+
30+
## Theme Structure
2131

22-
## base.scss
32+
### `base.scss`
2333

2434
* Basices required for backend
2535

26-
## barceloneta.scss
36+
### `barceloneta.scss`
2737

2838
* Barceloneta Theme basis
2939

3040

31-
# npm Package
41+
## npm Package
3242

3343
* npm package with files required for Plone
3444
* dependencies required by theme to compile
3545

3646

3747
# Bootstrap Components
3848

39-
* Default components are extended with some custom components (e.g. dropdown menu)
40-
* We use Boostrap variables in this cases
49+
* Default components are extended with some custom components, such as a select or dropdown menu.
50+
* We use Boostrap variables in these cases.
4151

4252

4353
# Add-Ons and Templates
4454

45-
Make live easy with...
55+
Make life easy with...
4656

4757
* use Bootstrap markup
4858
* use Bootstrap components
49-
* use Bootsrap variables
59+
* use Bootstrap variables

docs/classic-ui/theming/diazo.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
(classic-ui-theming-diazo-label)=
2+
13
# Plone Classic UI Theming with Diazo
24

35
Theming based on Diazo.

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

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
(classic-ui-theming-from-scratch-label)=
2+
13
# Plone Classic UI Theming based on Barceloneta
24

5+
```{todo}
6+
This page is only an outline and needs a lot of work.
7+
```
8+
39
Theming based on a filesystem package without any dependency.
410

511
* Theming for Plone 6 Classic UI
@@ -9,23 +15,23 @@ Theming based on a filesystem package without any dependency.
915
* No Diazo needed
1016

1117

12-
# Theme Package
18+
## Theme Package
1319

1420
* Create a theme package as explained here.
15-
* Temove what you do not need
21+
* Remove what you do not need
1622
* Add [package.json](https://github.com/collective/plonetheme.munich/blob/master/package.json)
1723
* Overrides
1824
* Static files
1925

2026

21-
# Static Files
27+
## Static Files
2228

2329
Register directory to keep static files
2430

2531
File: src/plonetheme/munich/browser/configure.zcml
2632
Directory: src/plonetheme/munich/browser/static
2733

28-
```
34+
```xml
2935
<!-- Publish static files -->
3036
<plone:static
3137
name="plonetheme.munich"
@@ -34,14 +40,14 @@ Directory: src/plonetheme/munich/browser/static
3440
/>
3541
```
3642

37-
# Theme
43+
## Theme
3844

39-
## Manifest
45+
### Manifest
4046

4147
* Manifest for your theme
4248
* Keep rules empty to disable Diazo
4349

44-
```
50+
```ini
4551
[theme]
4652
title = Munich Theme
4753
description = A modernized Plone 6 theme
@@ -51,9 +57,9 @@ prefix = /++theme++plonetheme.munich
5157
doctype = <!DOCTYPE html>
5258
```
5359

54-
## Bundle Registration
60+
### Bundle Registration
5561

56-
```
62+
```xml
5763
<?xml version="1.0"?>
5864
<registry
5965
xmlns:i18n="http://xml.zope.org/namespaces/i18n"
@@ -70,51 +76,52 @@ doctype = <!DOCTYPE html>
7076
</registry>
7177
```
7278

73-
## Theme Registration
79+
### Theme Registration
7480

7581
Register your theme via theme.xml
7682

77-
```
83+
```xml
7884
<?xml version="1.0" encoding="UTF-8"?>
7985
<theme>
8086
<name>munich</name>
8187
<enabled>true</enabled>
8288
</theme>
8389
```
8490

85-
## Compile the bundle
91+
### Compile the bundle
8692

8793
* Compile SASS to SCSS
8894

8995
Install all requirements and dependencies from package.json:
9096

91-
```
97+
```shell
9298
yarn install
9399
```
94100

95101
Build the actual bundle:
96102

97-
```
103+
```shell
98104
yarn dist
99105
```
100106

101107

102-
# Theming
108+
### Theming
103109

104110
* Make use of Bootstrap [variables](https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss)
105111
* Tweak basic settings like rounded corners, shadows, etc.
106112
* Set custom fonts
107113
* Define your own stuff
108114
* Import Boostrap (as basis)
109115

110-
## Templates
116+
117+
#### Templates
111118

112119
* Add z3c.jbot overrides
113120
* Copy Templates to customize
114121
* Add custom views for your story
115122

116123

117-
# Available Themes
124+
### Available Themes
118125

119126
* plonetheme.tokyo (mobile first, onw column)
120127
* plonetheme.munic (minimalistic)

docs/classic-ui/theming/index.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# Plone Classic UI Theming
1+
# Plone 6 Classic UI Theming
22

3-
TODO
3+
```{todo}
4+
This page is only an outline and needs a lot of work.
5+
```
46

5-
# Contents
7+
```{toctree}
8+
:maxdepth: 2
69
7-
* Basics and Requirements
8-
* Minor CSS changes via controlpanel (TTW)
9-
* Theming based on Barceloneta
10-
* Theming from scratch (without dependencies)
11-
* Theming with Diazo
10+
barceloneta
11+
diazo
12+
from-scratch
13+
through-the-web
14+
```

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
# Through-the-web (TTW) Theme Customization in Plone 6 Classic UI
44

5+
```{todo}
6+
This page is only an outline and needs a lot of work.
7+
```
8+
59
TTW customization is useful when you need to make small CSS changes.
610
Theme changes can be made via control panels or by updating Plone 6 Classic UI's `custom.css`.
711
Other theming methods should be used for larger customizations or entire website designs.

docs/classic-ui/whatsnew.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
(classic-ui-whatsnew-label)=
2+
13
# What's new in Plone 6 Classic UI
24

35
- HTML markup is now based on [Twitter Bootstrap 5](https://getbootstrap.com/).

docs/contributing/setup-build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ html_meta:
33
"description": "How to set up the Plone Documentation locally"
44
"property=og:description": "How to set up the Plone Documentation locally"
55
"property=og:title": "Building and Checking the Quality of Documentation"
6-
"keywords": ""
6+
"keywords": "setup, build, documentation, quality, development, spellcheck, linkcheck"
77
---
88

99
(setup-build-label)=

0 commit comments

Comments
 (0)