adding docu to working with content/ Visual Design of Plone Web Sites

plone/Products.CMFPlone#1734
plone · Mar 19, 2017 · 97d75b2 · 97d75b2
1 parent ba72aeb
commit 97d75b2
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,4 @@ _locales
 develop/coredev
 develop/plone.api
 develop/addons/bobtemplates.plone
-
+.project
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -11,7 +11,8 @@ Unreleased
 - Remove Deliverance info for theming and refer to diazo.org deployment [fredvd]
 - Improve ReStructuredText Style Guide [svx]
 - Add documentation about TinyMCE styles and formats [davilima6]
-
+- Documentation for Thumbs and Iconhandling in Plone 
+  https://github.com/plone/Products.CMFPlone/issues/1734 [fgrcon]
 
 20160606
 ========

diff --git a/_static/contents-with-thumbs-suppressed.png b/_static/contents-with-thumbs-suppressed.png
diff --git a/_static/contents-with128x128.png b/_static/contents-with128x128.png
diff --git a/_static/icons.png b/_static/icons.png
diff --git a/_static/icons2.png b/_static/icons2.png
diff --git a/_static/thumbs-example-1.png b/_static/thumbs-example-1.png
diff --git a/develop/plone/searching_and_indexing/indexing.rst b/develop/plone/searching_and_indexing/indexing.rst
@@ -383,7 +383,12 @@ Some interesting columns
 
 * getRemoteURL: Where to go when the object is clicked
 
-* getIcon: Since Plone 5.0.2 - Boolean value which is set to :guilabel:``True``, when item has or is an image (used for showing thumbs in lists, portlets, etc. ). Content type icons (aka portaltype-icons) ( e.g.: for folder, document, news item etc.) are rendered as fontello fonts since Plone 5.0.
+* getIcon: **This might be confusing:** 
+           Since Plone 5.0.2 - **getIcon is a boolean value which is set to ``True``, when the item is an image ore has an image property (named image)
+           e.g.: lead image or teaser image).** The value of getIcon is used for showing previoew images (thumbs) in lists, tables, content view, portlets, etc.). 
+
+           Content type icons (aka portaltype-icons) ( e.g.: for folder, document, news item etc.) are now rendered as fontello fonts since Plone 5.0.
+           Mime type icons are read from the mime type registry for all file content types instead a fontello font (since Plone 5.1) 
 
 * exclude_from_nav: If True the object won't appear in sitemap, navigation tree
 

diff --git a/working-with-content/introduction/visual-design-of-plone.rst b/working-with-content/introduction/visual-design-of-plone.rst
@@ -55,3 +55,52 @@ What does a Plone web site look like?
 Traditionally, the out-of-the-box look is like that shown at the top of this page, with
 header, menu, columns, and a footer.
 But using the flexible "Diazo" theme engine of Plone, each aspect can be made to look any way the designer chooses, and can also be shown different depending on the device of the visitor.
+
+
+Icons and Preview Images (aka Thumbs)
+-------------------------------------
+
+**Icons** are used to highlight actions, options etc. in menu bars, property sheets and the like:
+
+.. figure:: /_static/icons.png
+   :align: center
+   :alt: Icons used in Plone user interface
+
+
+
+Furthermore **icons** can be used to help to visually identify **content types** in any kind of listing or tables.
+For the content type *File* mime type icons are used to visualize the format of the given file.
+
+This feature is adjustable to a very high degree. There are default settings which can be configured in the `Site Configuration panel </adapt-and-extend/config/site.html>`_.
+This default settings can be overidden for each content item (edit: settings) or portlet respectively. 
+
+
+.. figure:: /_static/icons2.png
+   :align: center
+   :alt: Content type icons
+
+
+**Preview Images (or thumbnails, thumbs)**  for image items or any other content items which have a lead image
+(or teaser image) can be shown in any listing or table. 
+Additional to the same configuraion options for icons above you can define default sizes for the preview images for, tables, lists or portlets and also overwrite these settings individually.  
+
+
+.. figure:: /_static/thumbs-example-1.png
+   :align: center
+   :alt: Example: preview images and icons with different settings
+
+
+Depending on the default settings for table views the  content view of a folder will show preview images or not:
+
+
+.. figure:: /_static/contents-with-thumbs-suppressed.png
+   :align: center
+   :alt: Example: content view with thumbs not shown
+
+
+.. figure:: /_static/contents-with128x128.png
+   :align: center
+   :alt: Example: content view with thumbs  shown
+
+
+The second option (here with image size set to 128x128) is very handy whenever you need to rearrange a big number of images whith mkore or less meaningless title.