Skip to content

Commit a22a151

Browse files
committed
add more info
1 parent edc050c commit a22a151

File tree

3 files changed

+77
-5
lines changed

3 files changed

+77
-5
lines changed

icons.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,28 @@ Icons are shipped via plone.staticresources. Check out the [package.json](https:
1717
# Registration
1818

1919
* Icons are registered in Plone's registry
20-
* Override of icons via xml
20+
* Registrered to override of icons via xml
21+
* Option to customize UI and contenttype icons
2122
* [Bootstrap Icons](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_bootstrap.xml)
2223
* [Contenttypes](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_contenttype.xml)
2324
* [Plone UI](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_plone.xml)
2425

2526

27+
# Contextual Icons
28+
29+
We definde contextual icons. If you don't like e.g. the share icon - override it without touching the share icon used by the system.
30+
31+
* Icons like copy, cut, paste
32+
* Identical function all over the site
33+
* That's why we reuse those icons
34+
* Specific icon name is based on the usage in the system
35+
36+
## Icon expression
37+
38+
* icon_expression field is used again to define icons (e.g. for actions, contenttypes)
39+
* Use icon name for icon expressions
40+
41+
2642
# Customization
2743

2844
* Add custom icons
@@ -32,9 +48,9 @@ Icons are shipped via plone.staticresources. Check out the [package.json](https:
3248

3349
# Icon Font
3450

35-
* TODO
3651
* Setup profile to install icon font
3752
* Usage as known from e.g. Font Awesome
53+
* TODO
3854

3955

4056
# Iconresolver
@@ -49,8 +65,16 @@ URL method of @@icons view returns the actual URL to the SVG icon. This can be u
4965

5066
## Get Icon Tag
5167

52-
Tag method is used with tal:replace and returns an entire inline SVG image. tag_class and tag_alt is used to pass in custom classes and an alt text.
68+
Tag method is used with tal:replace and returns an entire inline SVG image. Inline icons can be styled via CSS. tag_class and tag_alt is used to pass in custom classes and an alt text.
5369

5470
```
5571
<tal:icon tal:replace="structure python:icons.tag('archive', tag_class='custom-class', tag_alt='foobar')" />
5672
```
73+
74+
## Resource Path
75+
76+
SVG Files are avaiblae as resource.
77+
78+
```
79+
++plone++bootstrap-icons/lightning.svg
80+
```

theming/barceloneta/index.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,49 @@
11
# Plone Classic UI Theming based on Barceloneta
22

3-
* TODO
4-
* SCSS
3+
* Use of SCSS
54
* Colors, fonts and sizes via variable changable
65
* Properties for shadows, rounded corners, gradients, etc.
76
* plonetheme.barceloneta npm package for includes
87
* bobtemplates.plone template
8+
* Theming is based on Bootstrap 5
9+
* We used Bootstrap markup in templates
10+
* We used Bootstrap components wherever possible
11+
* Most of look and feel can be touched via Bootstrap's variables
12+
* Hint: order is important in SCSS
13+
14+
15+
# Theme Package
16+
17+
* Generated theme package can be uploaded as ZIP-file
18+
19+
20+
# Theme Structure
21+
22+
## base.scss
23+
24+
* Basices required for backend
25+
26+
## barceloneta.scss
27+
28+
* Barceloneta Theme basis
29+
30+
31+
# npm Package
32+
33+
* npm package with files required for Plone
34+
* dependencies required by theme to compile
35+
36+
37+
# Bootstrap Components
38+
39+
* Default components are extended with some custom components (e.g. dropdown menu)
40+
* We use Boostrap variables in this cases
41+
42+
43+
# Add-Ons and Templates
44+
45+
Make live easy with...
46+
47+
* use Bootstrap markup
48+
* use Bootstrap components
49+
* use Bootsrap variables
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
# Plone Classic UI Theme Add-On
22

33
Create a filesystem package to keep an installable theme for Plone 6 Classic UI.
4+
5+
# bobtemplates.plone
6+
7+
* Boilerplate
8+
* package.json
9+
* Fertige basis
10+
* Plone CLI

0 commit comments

Comments
 (0)