Skip to content

Commit

Permalink
Merge pull request #896 from plone/20241203-tkn-editor-training
Browse files Browse the repository at this point in the history
Plone Training Guide for Content Editors
  • Loading branch information
tkimnguyen authored Dec 9, 2024
2 parents 00f097d + ce51aae commit a324d46
Show file tree
Hide file tree
Showing 18 changed files with 2,287 additions and 0 deletions.
166 changes: 166 additions & 0 deletions docs/content-editing/add-a-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
---
myst:
html_meta:
"description": "Add a File"
"property=og:description": "Add a File"
"property=og:title": "Add a File"
"keywords": "Plone, Add, File"
---

# Add a File

You can add any type of file to your Plone site. Files can be any "binary file", including PDFs, text files, videos, and Word documents.

You could follow this method to add an image, but rather than add an image as a file, you should add an image as an image! (see {ref}`Add an Image <add-an-image-label>`).

## Add a File

We add a file and look at other metadata that can be set on it and all content items in general.

1. Click the {guilabel}`add item` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/1f2c6537-df92-47ff-9640-89854e370b00/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=20,145)


2. Click {guilabel}`File`

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/31353de0-374e-4810-8587-7d91e0c49556/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=128,141)


3. Click the {guilabel}`Title` field and type a title.

If you don't provide a title, Plone will use the name of the file you upload.

The title will be indexed by Plone's built-in search and will appear in listings, such as in search results.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/a1fa92dd-0365-441a-a0bb-fa4c3b89a086/ascreenshot.jpeg?tl_px=282,189&br_px=2002,1150&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


4. Use the {guilabel}`Description` field to describe the file.

This description, or summary, will be indexed by Plone's search, and appears in listings such as in search results.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/d90b3aa4-c50a-4213-a01c-87123e0c9554/ascreenshot.jpeg?tl_px=292,329&br_px=2012,1290&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


5. Click {guilabel}`Choose a file` and use the dialog to select the file you want to upload, then press the dialog's {guilabel}`OK` button.

Alternatively, you can drag the file to the {guilabel}`Drop file here` target area.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/b693fff4-5dff-4bb4-90cd-b168f818ddd8/ascreenshot.jpeg?tl_px=302,645&br_px=2022,1606&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


6. Let's look at the other metadata you can set.

Click {guilabel}`Categorization`.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/d6395de3-0730-4cff-9940-3977ca6ea673/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=469,255)


7. This lets you assign tags, or keywords, to the current content item.

Tags are another way to describe the current content item.

Tags can be assigned to multiple content items, and are indexed by Plone's built-in search.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/4d7aff74-3ce2-4b6d-9c82-3a614f318287/ascreenshot.jpeg?tl_px=282,185&br_px=2002,1146&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


8. You can select existing tags.

To create new tags, you type each one followed by {kbd}`enter`.

For example, type "zope {kbd}`Enter` zope3 {kbd}`Enter` unit tests {kbd}`Enter` introduction {kbd}`Enter`"

9. Click on the {guilabel}`Language` drop down list to specify the language of the content item.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/18bfba02-4562-4f5e-9453-a78512a6ad05/ascreenshot.jpeg?tl_px=334,383&br_px=2054,1344&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


10. Click on the {guilabel}`Related Items` field to select other content items on the current site that are related to this one.

This lets you guide users to other content that may also be of interest to them.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/d42db505-b27d-4925-a521-a5b808e3249c/ascreenshot.jpeg?tl_px=304,501&br_px=2023,1462&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


11. You can select one or more related items by navigating and by searching the site.

In this example, we select as a related item the page "Content Types" by clicking on its icon.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/06209fcc-c929-4ca1-8b29-11f4d490b14f/ascreenshot.jpeg?tl_px=800,149&br_px=2520,1110&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=612,277)


12. Click the {guilabel}`X` button to exit from the related items selection widget.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/4cd278a7-beab-4bf2-aeaf-67edfab11983/ascreenshot.jpeg?tl_px=800,0&br_px=2520,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=1026,-2)


13. Click {guilabel}`Dates`

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/87435206-e2f8-4e23-912a-7ce9884c3418/ascreenshot.jpeg?tl_px=54,0&br_px=1774,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,254)


14. The Expiration Date lets you set when this item should no longer be shown in the site's navigation, e.g., in site headings.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/2bb7a016-e74e-4886-9346-cfb20ceaaee2/ascreenshot.jpeg?tl_px=252,369&br_px=1972,1330&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


15. Set the expiration date by clicking on the {guilabel}`Date` field. You can set the expiration time by clicking on the {guilabel}`Time` field.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/69c8feff-e4a0-46db-aa31-3d1ca6dd13b0/ascreenshot.jpeg?tl_px=726,937&br_px=2446,1898&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


16. The "Publishing Date" will be set automatically when you publish the item, so there is usually no need to set it.

You can set a publishing date in the future if you want to publish the item now but not have it highlighted in the site navigation until that future date and time.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/8fb5fa19-34f0-4676-aa6c-4f978d9859f2/ascreenshot.jpeg?tl_px=0,167&br_px=1719,1128&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=369,277)


17. Click {guilabel}`Ownership`

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/f91383b8-58f2-40a0-8d70-ac4e4b942015/ascreenshot.jpeg?tl_px=198,0&br_px=1917,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,258)


18. The Ownership fields let you set who created and contributed to the item. You can also set a copyright statement.

Click {guilabel}`Settings`.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/b3830cc0-ac52-469a-b1b8-2fe84b6c43a8/ascreenshot.jpeg?tl_px=404,376&br_px=2124,1338&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=530,18)


19. The "short name" for an item is what appears as part of the web address of the item.

By default, Plone takes the title of the item, lower cases it, and replaces spaces and other punctuation with hyphens ("-").

The "Short name" field lets you override what Plone will set by default.

Click the {guilabel}`Save` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/ef537edc-9b02-4e23-af47-da2e74fbc5d1/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=25,29)


20. You see the saved file's title, description (summary), a link to download the file, the file type and size.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/6ed81f99-288b-4d48-8a88-42d6d40923bb/ascreenshot.jpeg?tl_px=210,337&br_px=1929,1298&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


21. Click {guilabel}`demo1.pdf` to download the file.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/d55335a5-7dfa-45ad-9921-9fac08631e94/ascreenshot.jpeg?tl_px=0,491&br_px=1719,1452&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=494,277)


22. You also see the tags or keywords you assigned to the item.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/a84f1832-4abe-479e-a3a3-3afb1d404c13/ascreenshot.jpeg?tl_px=78,593&br_px=1797,1554&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


23. Click a tag to see other content items that have been assigned that tag.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/30af899f-2297-45b2-a4e8-b15dd13b6a44/ascreenshot.jpeg?tl_px=0,525&br_px=1719,1486&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=301,276)


24. Clicking on a tag shows you search results.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-16/4a862e6c-4d3a-48ad-994a-6df70092634d/ascreenshot.jpeg?tl_px=0,527&br_px=1719,1488&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=225,277)
69 changes: 69 additions & 0 deletions docs/content-editing/add-a-link.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
myst:
html_meta:
"description": "Add a Link"
"property=og:description": "Add a Link"
"property=og:title": "Add a Link"
"keywords": "Plone, Add, Link"
---

# Add a Link

You use a Link when you would like a page on your site to redirect a visitor to a web address external to your site.

A Link acts as bookmark on your site for something that is elsewhere on the Internet.

Here we show how to create a Link object that sends a visitor to an arbitrary web address.

1. In this example, we create a Link that will take someone to the video at the web address <https://www.youtube.com/watch?v=Yk7tx2zgL98>

Click the {guilabel}`add new` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/50a39f00-6926-449a-bc03-d5239de2cd90/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=16,146)


2. Click {guilabel}`Link`

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/96f8c716-4580-4548-8daf-84a0b99eb1c8/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=112,263)


3. Click the {guilabel}`Title` field and enter a title, e.g., "What Is World Plone Day?"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/4156914b-124b-4155-b135-173b5b84cedb/ascreenshot.jpeg?tl_px=298,197&br_px=2018,1158&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


4. Click the {guilabel}`Summary` field and enter a summary, e.g., "A video conversation explaining what is World Plone Day"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/f89b25d5-83b3-4786-b8f7-aa667987e79e/ascreenshot.jpeg?tl_px=304,357&br_px=2023,1318&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,276)


5. Click the {guilabel}`URL` field and enter the web address of the video, e.g., <https://www.youtube.com/watch?v=Yk7tx2zgL98>

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/fb56e174-b698-4e98-b7ef-d7ec2ed5c5b3/ascreenshot.jpeg?tl_px=290,577&br_px=2009,1538&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,277)


6. Click the {guilabel}`Save` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/25627ebf-d3df-4d34-9a28-eea37d0bc162/ascreenshot.jpeg?tl_px=0,0&br_px=1719,961&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=16,17)


7. The details of the Link you created are visible to you, the creator, and to a site manager, but a regular user or the public will be redirected immediately to the link address.

We will show this by logging out of the site.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/75d3f7bf-f7d4-4a1c-812a-2aadc212b946/ascreenshot.jpeg?tl_px=0,195&br_px=1719,1156&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=306,277)


8. Click the {guilabel}`personal menu` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/bcf767ad-dab3-4383-b35b-fbf42ba4d6f8/File.jpeg?tl_px=0,1000&br_px=1719,1962&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=13,541)


9. Click the {guilabel}`logout` button.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-11-25/4457be6f-965b-409a-813b-fdc847483ab5/ascreenshot.jpeg?tl_px=0,667&br_px=1719,1628&force_format=jpeg&q=100&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=436,276)


10. As soon as you are logged out of Plone, your browser reloads the page.

Because you are logged out, when your browser attempts to render the Link item and Plone recognizes that you do not have edit permissions on the Link, it redirects you to the web address of the video.
Loading

0 comments on commit a324d46

Please sign in to comment.