Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Working With Content as new Classic UI user guide #1547

Draft
wants to merge 7 commits into
base: 6.0
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/guides/classic-ui/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
myst:
html_meta:
"description": "User Guide for Plone 6 Classic"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace any and all instances of "Classic" with "Classic UI".

Suggested change
"description": "User Guide for Plone 6 Classic"
"description": "User Guide for Plone 6 Classic UI"

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

"property=og:description": "User Guide for Plone 6 Classic"
"property=og:title": "User Guide for Plone 6 Classic"
"keywords": "Plone, Classic, user, guide"
---

(deployment-label)=

# Deployment

```{todo}
Intro to chapter "deployment"
```

```{toctree}
:maxdepth: 2

provision
scaling
backup
caching/index
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Adding Collections

Collections (formerly called Smart Folders) are virtual containers of
lists of items found by doing a specialized search.

See the later section of the manual {doc}`../using-collections/index`

Choose "Collection" in the *Add new...* menu for a folder to start defining your collection:

```{figure} adding-collections_add-menu.png
:align: center
:alt: add new collection menu image
```

Select **Collection** from the drop-down menu, and you'll see the *Add Collection* panel:

```{figure} adding-collections_add-form.png
:align: center
:alt: collection form
```

Apart from the usual fields, the interesting part starts with the **Search terms**

```{figure} collection-criteria.png
:align: center
:alt: true
```

You can pick all *meta-data* that Plone has on content items as criteria.
By combining more criteria, you can create sophisticated queries, which will be automatically updated.

Your collection can search for all items of types `Page` and `News Item` that have a Tag of `Sport`, created in the last 3 months.
Or all `Events` that have a Start date in the next month.

The possibilities are endless, and Plone will always show the results according to the criteria.

If you create a new content item later with the tag of "Sport", it will automatically show up in the collection you have just defined.

## History

Collections have been around under various names. They used to be called "Smart Folders" in earlier versions of Plone, and you may find references to that in older documentation. It may even be that your site has so-called "Old Style collections" enabled as well.

See the later section of the manual {doc}`../using-collections/index`
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Adding Events

Plone web sites have a built-in system for managing and showing calendar events.

Use the *Add new...* menu for a folder to add an event:

```{figure} adding-events_add-menu.png
:align: center
:alt: add-new-menu.png
```

Select **Event** from the drop-down menu, and you'll see the rather large *Add Event* panel:

```{figure} adding-events_add-form.png
:align: center
:alt: Adding events form
```

From the top, we have the following fields:

- *Title* - **REQUIRED**
- *Summary*
- *Event starts* - **REQUIRED**
- *Event ends* - **REQUIRED**
- *Whole Day*
- *Open End*
- *Recurrence*
- *Event Location*
- *Attendees*
- *Contact Name*
- *Contact Email*
- *Contact Phone*
- *Event URL*
- *Event body text* (visual editor panel)
- Change note

```{note}
Only three fields, title and start and end date and time, are required.
```

Although this is a large input panel, if you are in a hurry, type in the title and the start and end times and save.
Of course, if you have the other information, you should type it in.

One part of the panel needs a bit more explanation: the event start and end times.
Both these can be set using a handy pop-up calendar. This will show when you click on the date.

Setting an event to be "Whole day" will remove the start and end times.

But there are many more options: you can set an event to be "Open-ended" if you don't know when the end date is, or if it is an ongoing activity that you would still like to show as an event.

For repeating events, use the "recurrence" link. You can set when, and how often, your event will repeat: daily, weekly, every third Tuesday of the month until 2017, etcetera. You can specify that an event should repeat a certain number of times, or until a certain date.

```{note}
**IMPORTANT:** Your event will not show on the main web site calendar until it has been **published**.
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Adding Files

Files of various types can be uploaded to Plone web sites.

Choose file in the *Add new...* menu for a folder to upload a file:

```{figure} adding-files_add-menu.png
:align: center
:alt: add-new-menu.png
```

Select **File** from the drop-down menu, and you'll see the *Add File* panel:

```{figure} adding-files_add-form.png
:align: center
:alt: true
```

Click the *Browse* button to navigate to the file you want to upload from your local computer. Provide a title (you can use the same file name used on your local computer if you want).
Provide a *description* if you want. When you click the save button the file will be uploaded to the folder.

Example file types include PDF files, Word documents, database files, zip files... -- well, practically anything.
Files on a Plone web site are treated as just files and will show up in contents lists for folders, but there won't be any special display of them.
They will appear by name in lists and will be available for download if clicked.

There are specialized add-on tools for Plone web sites that search the content of files, or can provide a preview of for instance PDF or Office files.
If you are interested in this functionality, ask your Plone web site administrator.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Adding Folders

Adding folders to a Plone web site is the basic way of controlling the organization of content.

You have undoubtedly created folders (directories) on your computer's hard drive.
Personal computers use a hierarchy of folders to structure and organize the programs and files on the hard drive.
In Plone folders are essentially used the same way, except that they are created on a Plone web site, for organizing content in Plone's built-in storage system.

Folders are added by clicking the **Add new...** drop-down menu.
Select **Folder** from the menu:

```{figure} adding-folders_add-menu.png
:align: center
:alt: add-new-menu.png
```

You should now see the *Add Folder* screen:

```{figure} adding-folders_add-form.png
:align: center
:alt: true
```

Fill in the **Title**, which is required, as indicated by the red dot.
The **Summary** is optional; you can always come back to the edit panel if you need to add a description of the folder.
Summaries are useful when a site visitor uses the search tool included with Plone - results will display with both the Title and Summary of the item.

You also notice tabs along the top:

- *Default*, for entering the Title and Description fields,
- *Categorization,* for specifying categories that apply to the folder
(you may know these as *keywords*),
- *Dates*, for setting the time period when the folder should be
available for view on the web site,
- *Ownership*, for specifying the creator and/or contributors for the
content item,
- *Settings,* for allowing comments about the item, enabling {ref}`rst_prev-next-links`,
and choosing whether it shows in the navigation menu for the web
site.

These tabs are standard, so you'll see them when you click other content types.
We will cover these tabs in another section of this user manual.

Be sure to click **Save** at the bottom of the page when you are finished.
This will complete the folder creation process.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Adding Images

Adding images to a Plone web site is a basic task that may involve a little work on your local computer, but is essential, because photographs, maps, and custom graphics are so important on web sites.

{doc}`preparing-images-for-the-web`

```{note}
Remember to use web-standard file formats for all images.
Acceptable formats include: JPG, JPEG, GIF, and PNG.

Do not use BMP or TIFF formats as these are not widely supported by web browsers, and can lead to slower websites.\*\*
```

When you are ready to upload an image, use the *Add new...* drop-down menu.

```{figure} adding-images_add-menu.png
:align: center
:alt: add-new-menu.png
```

After clicking to add an **Image**, you'll see the *Add Image* panel:

```{figure} adding-images_add-form.png
:align: center
:alt: Adding images form
```

The Title and Description fields (field, as in "data input field") are there, as with adding a Folder, and at the bottom there is a place to upload an image.
Let's look at the three input fields individually:

- *Title* - Use whatever text you want, even with blanks and
punctuation (Plone handles web addressing).
- *Description* - Always a good idea, but always optional. Leave it
blank if you want.
- *Image* - The Image field is a text entry box along with a Browse...
button. You don't have to type anything here; just click the Browse
button and you'll be able to browse you local computer for the image
file to upload.

For images, at a minimum, you will browse your local computer for the image file, then click **Save** at the bottom to upload the image to the Plone web site.

You'll have to wait a few seconds for the upload to complete.
A preview of the uploaded image will be shown when the upload has finished.

Images and files that you upload into Plone have their IDs (URLs) based on the title that you give to the image (instead of the file name of the image or file).

However, if you leave the title empty, the name of the item will default to the name of the file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Adding Links

In addition to links embedding within pages, Links can be created as discrete content items.
Having links as discrete items lets you do things like organizing them in folders, setting keywords on them to facilitate grouping in lists and search results, or include them in navigation.

Add a link by clicking the menu choice in the *Add new...* menu:

```{figure} adding-links_add-menu.png
:align: center
:alt: add-new-menu.png
```

You will see the Add\*Link\* panel:

```{figure} adding-links_add-form.png
:align: center
:alt: Adding links form
```

Good titles for links are important, because the titles will show up in lists of links, and because there tend to be large numbers links held in a folder or collection.

Paste the web address in the URL field or type it in.
There is no preview feature here, so it is best to paste the web address from a browser window where you are viewing the target for the link to be sure you have the address correct.

## The Link Object in Use

A link object will behave in the following ways, depending on your login
status, or permissions.

- **If you have the ability to edit the link object**, when you click on the link object you'll be taken to the object itself so that you can edit it (otherwise you'd be taken to the link's target and could never get to the edit tab!)
- **If you don't have the ability to edit the link object**, when you click on the link object you'll be taken to the target of the link object. Likewise, if you enter the web address of the link object
directly in your browser, you'll be taken directly to the link's target. The link object in this case acts as a *redirect*.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Adding New Content

A general overview of how to add new content items in Plone, including definitions of each standard content type

New content items are added via the **Add New . . .** drop-down menu:

```{figure} adding-content_add-menu.png
:align: center
:alt: add-new-menu.png
```

Adding content in Plone is done *placefully*, which means you should navigate to the section of your Plone website where you want the new content to reside **before** you use the **Add New . . .** drop-down menu.
You can of course cut, copy, and paste content items from one section to another if needed at any later time.

## Content Types

In Plone, you can use a number of **Content Types** to post certain kinds of content.
For example, to upload an image you must use the **Image** content type.
Below is a list of the available content types in order of their appearance, and what each are used for:

Collection

: Collections are used to group and display content based on a set of **criteria** which you can set. Collections work much like a query does in a database.

Event

: An Event is a content type specifically for posting information about an event (such as a fundraiser, meeting, barbecue, etc).
This content type has a function which allows the site visitor to add the event to their desktop calendar. This includes applications such as: Google Calendar, Outlook, Sunbird and others.
To add a single event to your calendar, click on the iCal link next to the "Add event to calendar" text in the main view of the event item.

```{figure} events-summary-chart.png
:align: center
:alt: events-summary-chart.png
```

You can also get all the events in a folder in one go (currently only available in iCal format).
To download the iCal file, append *@@ics_view* to the end of the URL of the folder or collection containing the events.
For example, if you want to get all the events from the *events* folder in the root of your site,go to *http://example.com/events/@@ics_view*.

File

: A File in Plone is any binary file you wish to upload with the intent to be downloaded by your site visitors. Common examples are PDFs, Word Documents, and spreadsheets.

Folder

: Folders work in Plone much like they do on your computer. You can use folders to organize your content, and to give your Plone website a navigation structure.

Image

: The Image content type is used for uploading image files (JPG, GIF, PNG) so that you can insert them into pages or other page-like content types.

Link

: Also referred to as the 'Link Object'; do not confuse this with the links you create with the visual editor on pages or other content types.
The Link content type is often used to include a link to an external website in Navigation and other specialized uses.

News Item

: This content type is similar to a Page, only a News Item is specifically for posting news.
You can also attach a thumbnail image to a News Item, which then appears in folder summary views next to the summary of the News Item.

Page

: A Page in Plone is the basic content types.
Use Pages to write the bulk of your web pages on your Plone website.

Note: Depending on what add-on products you have installed, you may see more options in your **Add New . . .** drop-down menu than appear here.
For information about those additional content types, refer to the Product documentation for the add-on in question.

## Title

Nearly all content types in Plone have two fields in common: **Title** and **Description.**

The **Title** of content items, including folders, images, pages, etc., can be anything you want -- you can use any keyboard characters, including spaces.
**Titles** become part of web address for each item you create in Plone.
Web addresses, also known as URLs, are what you type in a web browser to go to a specific location in a web site (Or, you would click your way there), such as:

www.mysite.com/about/personnel/sally/bio

or

www.mysite.com/images/butterflies/skippers/long-tailed-skippers

Web addresses *do* have restrictions on allowed keyboard characters, and spaces are not allowed.
Plone does a good job of keeping web addresses correct by using near-equivalents of the **Title** that you provide, by converting them to lowercase, and by substituting dashes for spaces and
other punctuation.

The web address of a given item is referred to as the **short name** in Plone.
When you use the **Rename** function, you'll see the short name along with the title.

The fields will vary according to the content type.
For instance, the Link content type has the URL field.
The File content type has the File field, and so on.

## Description

The **Description** appears at the top of pages, just under the Title.
Descriptions are often used to conjunction with a variety of Folder and Collection views (such as Standard and Summary).
The Description also appears in search results via Plone's native search engine.

The Description is just plain text, without any form of mark-up. This is to keep it inline with the {term}`Dublin Core` standard, a long-established way of categorizing information.
Loading
Loading