[BUILD-79] Examples in CMS taglib reference unreadable Created: 08/Nov/11  Updated: 30/Oct/17

Status: Open
Project: Build
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Neutral
Reporter: Lauri Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to BUILD-200 Introduce asciidoc for Javadoc Closed
Template:
Acceptance criteria:
Empty
Date of First Response:

 Description   

Examples on tag reference page collapsed into single line and are unreadable. Quite often html entities appear as code.

I.e.
cms:adminOnly



 Comments   
Comment by Lauri [ 08/Nov/11 ]

Other issues with tag tib documentation include:
1) Taglib reference is not on left side of http://documentation.magnolia-cms.com/reference.html menu, so easy to miss
2) Not enough of examples for taglibs IMO. There're plenty of tags with number of different parameters, one has to explore the tag behaviour instead.

Comment by Antti Hietala [ 08/Nov/11 ]

Moved ticket to BUILD project to fix the tag library rendering issues. These are generated by Nexus.

Added tag library to Javadoc. This addresses point 1 in comment.

Comment by Philip Mundt [ 07/Nov/14 ]

This is due to the taglib plugin which hasn't seen any updates since years.
See recent example that still shows problems:
https://nexus.magnolia-cms.com/content/sites/magnolia.public.sites/ref/5.3.5/magnolia-templating-jsp/tagreference.html
Tag Library Documentation is also problematic:
https://nexus.magnolia-cms.com/content/sites/magnolia.public.sites/ref/5.3.5/magnolia-templating-jsp/tlddoc/index.html

We could probably fix it by forking the plugins... ahietala, is it worth it?

Comment by Antti Hietala [ 10/Nov/14 ]

Formatting works in Javadoc, see simpleNavigation:
https://nexus.magnolia-cms.com/content/sites/magnolia.public.sites/ref/5.3.5/magnolia-templating-jsp/tlddoc/index.html

Formatting breaks in Nexus sites: https://nexus.magnolia-cms.com/content/sites/magnolia.public.sites/ref/5.3.5/magnolia-templating-jsp/tagreference.html#cmsUtilTaglib:simpleNavigation

I would either update/fork the plugin or stop generating the broken markup since we have Javadoc for the same.

Comment by Magnolia International [ 18/Mar/15 ]

We need to check if this can somewhat work with Asciidoc. It would certainly make the doc more readable and easier to maintain on our side.

Generated at Sun Feb 11 23:38:33 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.