Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/5.2'
Browse files Browse the repository at this point in the history
# Conflicts:
#	gradle.properties
  • Loading branch information
alansemenov committed May 29, 2024
2 parents dc50d31 + 3efbc6c commit 5794cde
Show file tree
Hide file tree
Showing 18 changed files with 148 additions and 21 deletions.
10 changes: 8 additions & 2 deletions docs/actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ button dropdown in the *Archive item(s)* dialog.

IMPORTANT: Online content will instantly go offline after archiving or deleting.

image::dialog-archive.png[Archive item(s) dialog, 600]
image::dialog-archive.png[Archive item(s) dialog, 75%]

If any of the items in the dialog has an inbound dependency (is referenced by another content), a warning will be shown on top of the dialog and the action button will be disabled. User can either click "Ignore inbound references" link to ignore the warning and proceed with archiving/deletion, or click "Show references" link for every referenced item and remove the references (the dialog will be automatically refreshed).

image::dialog-archive-references.png[Archive item(s) dialog, 600]
image::dialog-archive-references.png[Reference check in the Archive item(s) dialog, 75%]


== Duplicate
Expand Down Expand Up @@ -280,6 +280,12 @@ image::dialog-unpublish.png[]

NOTE: Just like with deletion, you will be asked to confirm the Unpublish action by entering the total number of items to be unpublished.


If any of the items in the dialog has a *published* inbound dependency (is referenced by another *published* content), a warning will be shown on top of the dialog and the action button will be disabled. User can either click "Ignore inbound references" link to ignore the warning and proceed with unpublishing, or click "Show references" link for every referenced item, remove the references and publish the changes.

image::dialog-unpublish-references.png[Reference check in the Unpublish dialog, 75%]


== Create Issue

NOTE: In-depth reference on the issues can be found in the separate <<issues#,chapter>>.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion docs/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ he/she will be asked to create a new content project using <<settings#new_projec
Whenever the Publishing Wizard contains at least one item that is "_Work in progress_", publishing will be disabled. The editor can solve
this by clicking the "*Mark as ready*" link on top of the dialog, which will mark all such items as "_Ready for Publishing_".

image::pubwiz-mark-as-ready.png[Mark as ready action in the Publishing Wizard, 410]
image::pubwiz-mark-as-ready.png[Mark as ready action in the Publishing Wizard, 75%]

To add another level of restriction and prevent accidental publishing of items that are not ready for publishing, the "*Mark as ready*" bulk action
can be disabled by adding the following parameter to the config file:
Expand All @@ -95,6 +95,19 @@ can be disabled by adding the following parameter to the config file:
publishingWizard.allowContentUpdate = false
----

=== Default Online From time

Default Online From time is set to 08:00 by default. This default value can be changed by setting the `publishingWizard.defaultPublishFromTime` config property.

image::pubwiz-online-from.png[Default Online From time in the Publishing Wizard, 75%]


.Default Online From time in the Publishing Wizard
[source,properties]
----
publishingWizard.defaultPublishFromTime = 08:00
----

=== Exclude optional dependencies

By default, all dependencies of content items staged for publishing will also be included to ensure no broken
Expand Down
Binary file added docs/config/images/pubwiz-online-from.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/editor/content-form.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ in the <<page-editor#editing-page,Page Editor>>.

Components can be rearranged directly in the tree with drag’n’drop function.

In the image below, a part named *Post single* is selected in the Components view and the part is highlighted with a blue mask at the center of the page editor. The *Post single*’s configuration is visible in the components widget on the right.
In the image below, a part called *Latest comments* is selected in the Page Components view and highlighted with a blue border/mask in the Page Editor. The selected part's configuration form is displayed in the Components widget on the right.

image::wizard-component-view-docked.png[Page Components docked, 75%]
image::page-editor-components-docked.png[Page Components, 75%]

NOTE: For fragments and page templates the Page Components tree will be inside the first form step.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/editor/images/page-editor-components-view.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/editor/images/wizard-component-view-docked.png
Binary file not shown.
14 changes: 11 additions & 3 deletions docs/editor/rich-text-editor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,23 @@ This button opens a menu with special characters. Selecting one will insert it a

=== Anchor

Anchors enable pointing to a specfic position on a page via context link. If a link references an anchor on the same page then the page will scroll up or down to the location of the anchor. The anchor button in the toolbar opens the Insert Anchor dialog where the name of the anchor is entered. The anchor name will be used as the value of the “id” attribute, so it should be lower case without spaces.
Anchors enable pointing to a specific position on a page via context link. If a link references an anchor on the same page then the page will scroll up or down to the location of the anchor. The anchor button in the toolbar opens the Insert Anchor dialog where the name of the anchor is entered. The anchor name will be used as the value of the “id” attribute, so it should be lower case without spaces.

=== Insert/Edit image

This button opens the Insert Image dialog. An existing image content can be selected from the “Image” selector, or a new image can be uploaded using the upload button.
This button (or a double click on the image) opens the Insert Image dialog. An existing image content can be selected from the “Image” selector, or a new image can be uploaded using the upload button.

Once an image is selected, additional formatting options will appear. The image can be floated to the left or right so that text wraps around it.
The image can also be centered or set to full width. By checking off “Custom width” you will have an option to set relative width of the image.

Additionally, there's an option to apply <<rich-text-editor#custom_image_styles,custom image styles>>.
A caption and alt text can be entered at the bottom of the modal dialog. A double click on an image inside the Editor will open the modal dialog for editing properties of the image.

"Caption" field allows to enter a caption/title for the image and will be displayed under the image as a part of the `figure` element.

"Accessibility" section at the bottom allows to either set the image as decorative (meant to be discoverable only by screen readers, not actual users), or apply an alternative text for the image.

image::rich-text-editor-image-dialog.png[Insert Image dialog, 75%]


=== Insert macro

Expand Down
107 changes: 104 additions & 3 deletions docs/release.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,110 @@
= Release Notes

:imagesdir: release/images

:toc: right

TIP: Release Notes for Content Studio 4.x can be found https://developer.enonic.com/docs/content-studio/4.x/release[here]


== Content Studio 5 Update 2

IMPORTANT: Content Studio 5.2 requires XP 7.14.1 or higher.

=== What's new

video::MjWxNLDsUEc[youtube, 75%]

=== Project graph

:imagesdir: settings/images

By selecting "Projects" in the Content Studio's "Settings" module it's now possible to see visualised graph of existing content projects and their relations.

image::settings-grid.png[Project graph, 75%]

=== Project Wizard improvements

==== Preset parent project

If an existing project was selected in the Project tree when "New" button is clicked, the Project Wizard will create a layer of the selected project and set up synhronisation of data in the layer with its parent project.

==== Removed type selection

Before this release users had to explicitly select whether they are about to create a project or a layer. This requirement has been removed. If a parent project is selected on the first step of the Wizard, a layer will be created and set up to inherit data from the selected project. Otherwise, a regular project will be created.

image::new-project-dialog-1.png[Select parent project, 75%]

==== Parent project apps

A layer will always inherit applications from its parent project, even though it was not obvious from the UI before this release. "Applications" step of the "Project Wizard" has been changed to automatically display applications inherited from the parent project (if any), with no option to remove them. Other applications can be added to the layer in addition to the inherited ones.

Settings form of an existing layer has also been fixed accordingly.

In the screenshot below, the top two applications were inherited from the parent project, while the bottom one was added manually.

image::new-project-dialog-5.png[Apps inherited from parent project, 75%]

=== Reference check in the Unpublish Wizard

The Unpublish Wizard will now check if any of the content items to be unpublished are referenced by other _published_ content items. If there are inbound references, the user will be warned and asked to confirm the unpublish operation.

:imagesdir: actions/images

image::dialog-unpublish-references.png[Reference check in the Unpublish Wizard, 75%]

=== Decorative images

New "Accessibility" section in the <<editor/rich-text-editor#insertedit_image,Insert/Edit Image dialog>> of Rich Text editor allows to set decorative images as such. Decorative images are used for styling purposes only and meant to be skipped by screen readers, as opposed to images with meaningful alt text.

:imagesdir: editor/images

image::rich-text-editor-image-dialog.png[Insert Image dialog, 75%]

=== Default Online From time

:imagesdir: config/images

image::pubwiz-online-from.png[Default Online From time in the Publishing Wizard, 75%]

Default Online From time in the Publishing Wizard can now be configured in Content Studio's <<config#default_online_from_time,config file>>. If no config is set, the default time will be set to 12:00.

=== Page Components view

Styling of regions inside the Page Components view has been changed to make regions take less space and attention away from the main page components. Region names are now capitalized.

:imagesdir: release/images

image::cs52-pcv-regions.png[Regions in the Page Components view, 75%]

=== Other improvements

==== Performance

Preview and Page Editor panels will no longer be refreshed whenever content is published or unpublished.

==== Soft-hyphen in the Rich Text Editor

Soft-hyphen character `\&shy;` added to Rich Text Editor's "Special chars" dialog.

==== Email sender

Before this release, email notifications for <<issues#,issues>> created in Content Studio used current user's email address in the sender field. A new https://developer.enonic.com/docs/xp/stable/deployment/config#mail[config property^] was implemented in XP 7.14.1 which can be used to configure default email sender for emails sent by XP. If properly configured, the sender field in the email notifications sent for issues in Content Studio will be set to the configured email address.

==== eXtra Data

Layout and behaviour of optional X-Data sections in the Content Form have been changed. `+` icon is now right-aligned and transforms to `x` icon whenever the X-Data is active.

image::cs52-x-data.png[x-data in the Content Editor form, 75%]

== Content Studio 5 Update 1

IMPORTANT: Content Studio 5.1 requires XP 7.13.0 or higher.

=== What's new

video::Lc8GVT7V5cU[youtube, 75%]

=== Improved move operation

* Move Content dialog: New "Project root" node on top of the content tree to make it more obvious how to move content to the root. Previously one had to click "Move" button with no target content selected.
Expand Down Expand Up @@ -35,15 +132,15 @@ Search results produced by Content Navigator's <<navigator#search_panel,Search P

:imagesdir: release/images

image::cs51-search-export.png[Search export, 25%]
image::cs51-search-export.png[Search export, 75%]

=== New Find/Replace dialog in Rich Text Editor

The old <<editor/rich-text-editor#findreplace,Find/Replace dialog>> in the Rich Text Editor that used to cover the text it was searching inside has been replaced with the new inline dialog that allows editor to use the search/replace functions without blocking the source text.

:imagesdir: editor/images

image::rich-text-editor-find-replace.png[470, Insert Link dialog]
image::rich-text-editor-find-replace.png[Insert Link dialog, 75%]

=== Locked path for published content

Expand All @@ -65,6 +162,10 @@ Previously, editor had to click the "lock" icon next to the locked path input in

IMPORTANT: Content Studio 5.0 requires XP 7.13.0 or higher.

=== What's new

video::hB8TOBjRxYc[youtube, 75%]

=== Default Content Project is hidden by default

Default Content Project is no longer available in Content Studio without tweaking the config file.
Expand All @@ -80,7 +181,7 @@ of the <<editor/content-form#page_components_tree,Content Editor form>>. It will

:imagesdir: editor/images

image::wizard-component-view-docked.png[Page Components view - Docked, 75%]
image::wizard-component-view-collapsed.png[Page Components view - Docked, 75%]
image::wizard-component-view-floating.png[Page Components view - Floating, 75%]

=== Publishing Wizard improvements
Expand Down
Binary file added docs/release/images/cs52-pcv-regions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/release/images/cs52-x-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 9 additions & 10 deletions docs/settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ the left-side menu.

image::top-level-menu.png[Top Level Menu, 642]

The Settings section lists all Content Projects that current user has permissions for. Users with roles
_Content Manager Administrator_ and _System Administrator_ will always have full access to all projects.
The Settings section displays all Content Projects that current user has permissions for in the form of a tree. Users with roles
_Content Manager Administrator_ and _System Administrator_ will always have full access to all projects. By selecting the top node called "Projects" you will display a graph of all content projects and their relations in the panel on the right.

image::settings-grid.png[Settings section, 600]

Expand All @@ -32,17 +32,13 @@ CAUTION: Deleting a project will delete its repository and all the data inside.

== New Project wizard

Project setup in Content Studio is done from the "_Settings_" section, which can be accessed by clicking the cog icon in the left-side menu.

Click "_New_" button in the toolbar to start the multistep New Project wizard dialog.
Click "_New_" button in the toolbar to start the multi-step New Project wizard dialog.

NOTE: Upload of project icon is not possible until after the project is created.

=== Project Type
=== Parent Project

On the first step of the Wizard select what type of project you want to create. Select "_Project_" for a top-level Content Project, or
"_Layer_" if you want to set up a localised project which will synchronise its contents with an upstream project/layer. In the latter case
you will also be asked to select the upstream project.
The first step of the Wizard determines whether you want to create a regular content project or a layer - a special kind of project which will inherit its data from the parent project. If you want to select a layer, select one of the existing projects from the dropdown list to be a parent of the new layer.

image::new-project-dialog-1.png[Project type, 470]

Expand Down Expand Up @@ -93,11 +89,14 @@ as opposed to site-oriented approach.

NOTE: Only applications containing `site.xml` can be assigned to content projects.

A layer will always inherit applications from its parent project. Apps inherited from the parent cannot be unselected, but other apps can be added to the layer in addition to the inherited ones.

In the screenshot below, the top two applications were inherited from the parent project, while the bottom one was added manually.

image::new-project-dialog-5.png[Applications, 470]

IMPORTANT: Applications assigned to projects will not work for a site or content items inside a site. Assign applications
directly to the site if you want to use them for site contents.
directly to the site if you want to use them for contents of a site.

=== Base Properties

Expand Down
Binary file modified docs/settings/images/new-project-dialog-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/settings/images/new-project-dialog-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/settings/images/project-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/settings/images/settings-grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5794cde

Please sign in to comment.