This issue has been created
There is 1 update.
 
 
Publication Workflow Application / cid:jira-generated-image-avatar-381bd2e7-4e15-48a0-88da-206111acba98 XAWORKFLOW-131 Open

Purpose of "Allow custom publication comment" Setting: Improve Documentation and Maybe UI?

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-48696889-f422-4c10-8c84-beaf7d96bd74 Gunter Ohrner created this issue on 14/Sep/26 18:49
 
Summary: Purpose of "Allow custom publication comment" Setting: Improve Documentation and Maybe UI?
Issue Type: cid:jira-generated-image-avatar-381bd2e7-4e15-48a0-88da-206111acba98 Improvement
Affects Versions: 2.4.9
Assignee: Unassigned
Created: 14/Sep/26 18:49
Priority: cid:jira-generated-image-static-major-43afe2c0-03bf-44c4-b06c-db32736f6d66 Major
Reporter: Gunter Ohrner
Description:

The Allow custom publication comment feature introduced by XAWORKFLOW-86 is currently only briefly documented and its intended use case is unclear.

The documentation should explain:

  • what the publication comment is intended to represent;
  • where and how it can be edited;
  • that it is stored on the draft's PublicationWorkflowClass object;
  • when and how it is copied to the published document's history;
  • whether it is intended to be changed for every publication or kept as a persistent document property.

Is this feature intended to provide a per-publication comment? If so, should the field be exposed directly in the Publish UI instead of requiring users to edit the draft's object manually?

 

(https://forum.xwiki.org/t/documentation-and-possibly-ui-for-publication-comment-edit-feature/18851)

 
 

1 update

 
cid:jira-generated-image-avatar-48696889-f422-4c10-8c84-beaf7d96bd74 Changes by Gunter Ohrner on 14/Sep/26 18:50
 
Description: The *Allow custom publication comment* feature introduced by XAWORKFLOW-86 is currently [ only briefly documented |https://extensions.xwiki.org/xwiki/bin/view/Extension/XWiki%20Publication%20Workflow%20Application#:~:text=Allow%20custom%20publication%20comment] and its intended use case is unclear - at least to me .

The documentation should explain:
* what the publication comment is intended to represent;

* where and how it can be edited;

* that it is stored on the draft's {{PublicationWorkflowClass}} object;

* when and how it is copied to the published document's history;

* whether it is intended to be changed for every publication or kept as a persistent document property.

Is this feature intended to provide a per-publication comment? If so, should the field be exposed directly in the *Publish* UI instead of requiring users to edit the draft's object manually?

 

(
[ https://forum.xwiki.org/t/documentation-and-possibly-ui-for-publication-comment-edit-feature/18851 ] )