[MAGNOLIA-7184] DOC: cmsfn.isPreviewMode() has inaccurate javadoc Created: 24/Oct/17  Updated: 16/Aug/22  Resolved: 16/Aug/22

Status: Closed
Project: Magnolia
Component/s: None
Affects Version/s: None
Fix Version/s: 6.2.23, 6.3.0

Type: Bug Priority: Neutral
Reporter: Ervin Vystup Assignee: Jaroslav Simak
Resolution: Fixed Votes: 0
Labels: javadoc, maintenance, quickwin
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
relation
is related to DOCU-1196 cmsfn.isPreviewMode() has inaccurate ... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MAGNOLIA-8520 Implementation Sub-task Completed Jaroslav Simak  
MAGNOLIA-8521 Review Sub-task Completed Marek Strucka  
MAGNOLIA-8522 piQA Sub-task Completed Marek Strucka  
MAGNOLIA-8523 QA Sub-task Completed  
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Epic Link: Support
Sprint: DevX 16
Story Points: 0.5
Team: DeveloperX

 Description   

The javadoc of cmsfn.isPreviewMode() templating function is inaccurate.

Returns whether the request is from the Page editor preview mode.

It matches requests from both (Author and Public) instances.

----------

In the "isEditMode" would be better to mention that it is only on the Author instance.

Returns whether the request is from the Page editor edit mode.
Specifically whether the request is on the author instance and not from the page editor in preview mode.
Useful for providing messages in the page to assist the editors.



 Comments   
Comment by Ervin Vystup [ 22/Dec/17 ]

To IsPreviewMode:
After some discussions with rkovarik and mdrapela we agreed to edit this sentence in the documentation to:

Checks whether the content is requested in the page editor in preview mode. The check can be run either on the author instance or on the public instance.

Checkforpreviewmode in the docu
so, similarly, it could be used here.

Generated at Mon Feb 12 04:21:30 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.