XWIKI-19383: Display a title on createlink #2104

Sereza7 · 2023-03-06T15:07:28Z

Jira: https://jira.xwiki.org/browse/XWIKI-19383
See xwiki/xwiki-rendering#256 for the changes on xwiki-rendering.
PR Changes:

Fixed the platform generated wikicreatelink spans
Created an implementation of URITitleGenerator

* Changed generation in the class editor on the platform

* Added an extension for rendering default behavior.

* Fixed wrong version tag

* Changed generation in the class editor on the platform

* Added an extension for rendering default behavior.

* Fixed wrong version tag

* Added an hint on the URITitleGenerator component

* Fixed the hint of the URITitleGenerator implementation

Sereza7 · 2023-03-16T16:18:40Z

PR Changes:

Solved the mismatch in hints for the URITitleGenerator implementation

NOTE: This commit needs to be merged with/after xwiki/xwiki-rendering#256

View:

* Refactored name and fixed hint to match DocumentXHTMLLinkTypeRenderer in xwiki-render.

manuelleduc · 2023-03-20T11:12:28Z

...iki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/displayer_page.vm

+      <span class="wikicreatelink"><a href="$pageDoc.getURL('create')"
+      title="$services.localization.render('core.create.inline.label', [$title])">$title</a></span>


Wrong formatting + escaping missing.

Suggested change

<span class="wikicreatelink"><a href="$pageDoc.getURL('create')"

title="$services.localization.render('core.create.inline.label', [$title])">$title</a></span>

<span class="wikicreatelink">

<a href="$pageDoc.getURL('create')" title="$services.localization.render('core.create.inline.label', [$title])">$title</a>

</span>

* Fixed escaping on title. * Properly formatted changes.

Sereza7 · 2023-03-20T13:24:50Z

PR Changes:

Fixed escaping on title.
Properly formatted changes.

mflorea

This PR looks unfinished.

...es/xwiki-platform-appwithinminutes-ui/src/main/resources/AppWithinMinutes/ClassEditSheet.xml

mflorea · 2023-03-29T07:26:31Z

...es/xwiki-platform-appwithinminutes-ui/src/main/resources/AppWithinMinutes/ClassEditSheet.xml

+  title="$services.localization.render('platform.',
+    ['#pageLink($translationsReference)']"


This looks wrong. The translation key is incomplete and there's a bracket missing.

mflorea · 2023-03-29T07:36:58Z

...wiki/src/main/java/org/xwiki/rendering/internal/renderer/XWikiDocumentURITitleGenerator.java

+import org.xwiki.rendering.renderer.reference.link.URITitleGenerator;
+
+/**
+ * Generate link titles for ATTACH URIs.


This doesn't match the class name. Is this about pages or attachments?

mflorea · 2023-03-29T07:37:14Z

...wiki/src/main/java/org/xwiki/rendering/internal/renderer/XWikiDocumentURITitleGenerator.java

+ * Generate link titles for ATTACH URIs.
+ *
+ * @version $Id$
+ * @since 15.2RC1


This needs to be updated.

mflorea · 2023-03-29T07:38:58Z

...wiki/src/main/java/org/xwiki/rendering/internal/renderer/XWikiDocumentURITitleGenerator.java

+        return this.contextLocalization.getTranslationPlain("core.create.inline.label",
+         attachmentReference.getName());


I don't understand, you're returning "Create page: attachmentName"? Doesn't make any sense. Also bad formatting.

👍 for the formatting.
When used on a rendered link, it seems to me like it works properly, the reference name is the name of the page we're looking to create. What should I use in its stead?

For reference, I just checked again this code in action:

[[Dead link>>The dead page that should be created]]

mflorea · 2023-03-29T07:40:18Z

...iki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/displayer_page.vm

@@ -55,9 +55,14 @@
    ## The view displayer generates HTML so we need to escape the XML special characters from the page reference.
    $escapetool.xml($pageReference)
  #else
-    #set ($title = $escapetool.xml($pageDoc.plainTitle))
+    #set ($title = $escapetool.velocity($pageDoc.plainTitle))


This is wrong. You need XML escaping because you're printing the value below in HTML.

* Fixed indents * Fixed documentation * Fixed the ClassEditSheet.xml call.

vmassol · 2023-03-29T15:13:36Z

Please add to the jira issue the exact WCAG problem (link to it) + mention if it's auto detected by Axe core or not, and if not, do we need to define a best practice for developers to avoid regressing on this (or other use cases) in the future.

vmassol · 2023-03-29T15:26:59Z

...wiki/src/main/java/org/xwiki/rendering/internal/renderer/XWikiDocumentURITitleGenerator.java

+ * @version $Id$
+ * @since 15.3RC1
+ */
+@Component(hints = {"doc", "page"})


Not needed.

vmassol · 2023-03-29T15:41:39Z

...wiki/src/main/java/org/xwiki/rendering/internal/renderer/XWikiDocumentURITitleGenerator.java

+    public String generateCreateTitle(ResourceReference reference)
+    {
+        DocumentReference documentReference =
+            this.currentDocumentReferenceResolver.resolve(reference.getReference());


This will only work for DocumentResourceReference and for other types, it'll cause a bug. For example SpaceResourceReference references won't be resolved correctly. Same problem for a page ResourceReference.

* Added implementations for other resource reference types. * Changed the l10n key names to be more specific TODO: * Fix tests

* Fixed the title on the wrong object in ClassEditSheet.xml * Took care of different cases in XWikiAttachmentWantedLinkTitleGenerator and XWikiDocumentWantedLinkTitleGenerator

michitux

There is one missing escaping (see comment). I'm not 100% sure regarding the different resolver implementations but it looks good.

michitux · 2023-05-26T15:54:26Z

...es/xwiki-platform-appwithinminutes-ui/src/main/resources/AppWithinMinutes/ClassEditSheet.xml

@@ -256,9 +256,13 @@ xcontext.put('propertyCustomDisplayer', new PropertyCustomDisplayer(xcontext))
    #set ($class = 'wikicreatelink')
    #set ($action = 'create')
    #set ($discard = $params.put('parent', $doc.fullName))
+    #set ($title = $services.localization.render('core.create.inline.label',[$reference.name]))


Missing escaping (either here or where it is used).

Addressed in 45a7315

* Escaped properly a title

* Updated since versions

Sereza7 added 3 commits February 28, 2023 14:32

XWIKI-19383: Display a title on createlink

8381449

* Changed generation in the class editor on the platform

XWIKI-19383: Display a title on createlink

bc0ab50

* Added an extension for rendering default behavior.

XWIKI-19450: Several nav tags are used without aria-label

38d8f97

* Fixed wrong version tag

Sereza7 marked this pull request as draft March 6, 2023 15:07

Sereza7 and others added 9 commits March 13, 2023 09:56

XWIKI-19383: Display a title on createlink

c54d463

* Fixed wrong version tag

Merge remote-tracking branch 'origin/XWIKI-19383' into XWIKI-19383

b4205eb

XWIKI-19383: Display a title on createlink

d6c8fa0

* Changed generation in the class editor on the platform

XWIKI-19383: Display a title on createlink

50548b2

* Added an extension for rendering default behavior.

XWIKI-19383: Display a title on createlink

d85e48f

* Fixed wrong version tag

Merge branch 'xwiki:master' into XWIKI-19383

9f7c059

Merge remote-tracking branch 'origin/XWIKI-19383' into XWIKI-19383

e6e1304

XWIKI-19383: Display a title on createlink

68639a6

* Added an hint on the URITitleGenerator component

XWIKI-19383: Display a title on createlink

79fc276

* Fixed the hint of the URITitleGenerator implementation

Sereza7 marked this pull request as ready for review March 16, 2023 16:16

Sereza7 mentioned this pull request Mar 16, 2023

XWIKI-19383: Display a title on createlink xwiki/xwiki-rendering#256

Draft

XWIKI-19383: Display a title on createlink

a88f48d

* Refactored name and fixed hint to match DocumentXHTMLLinkTypeRenderer in xwiki-render.

manuelleduc reviewed Mar 20, 2023

View reviewed changes

XWIKI-19383: Display a title on createlink

9b503b3

* Fixed escaping on title. * Properly formatted changes.

mflorea requested changes Mar 29, 2023

View reviewed changes

XWIKI-19383: Display a title on createlink

3cd61d7

* Fixed indents * Fixed documentation * Fixed the ClassEditSheet.xml call.

vmassol reviewed Mar 29, 2023

View reviewed changes

Sereza7 and others added 3 commits March 31, 2023 13:13

XWIKI-19383: Display a title on createlink

8501c6a

* Added implementations for other resource reference types. * Changed the l10n key names to be more specific TODO: * Fix tests

Merge branch 'xwiki:master' into XWIKI-19383

069e949

XWIKI-19383: Display a title on createlink

1bcb011

* Fixed the title on the wrong object in ClassEditSheet.xml * Took care of different cases in XWikiAttachmentWantedLinkTitleGenerator and XWikiDocumentWantedLinkTitleGenerator

michitux reviewed May 26, 2023

View reviewed changes

Sereza7 marked this pull request as draft May 30, 2023 07:40

Sereza7 and others added 5 commits August 18, 2023 16:27

Merge branch 'xwiki:master' into XWIKI-19383

1d2c7d7

XWIKI-19383: Display a title on createlink

45a7315

* Escaped properly a title

Merge branch 'xwiki:master' into XWIKI-19383

375bb2c

Merge branch 'xwiki:master' into XWIKI-19383

112f9f7

XWIKI-19383: Display a title on createlink

61c387b

* Updated since versions

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XWIKI-19383: Display a title on createlink #2104

XWIKI-19383: Display a title on createlink #2104

Sereza7 commented Mar 6, 2023

Sereza7 commented Mar 16, 2023

manuelleduc Mar 20, 2023

Sereza7 commented Mar 20, 2023

mflorea left a comment

mflorea Mar 29, 2023

mflorea Mar 29, 2023

mflorea Mar 29, 2023

mflorea Mar 29, 2023

Sereza7 Mar 29, 2023

mflorea Mar 29, 2023

vmassol commented Mar 29, 2023

vmassol Mar 29, 2023

vmassol Mar 29, 2023 •

edited

Loading

michitux left a comment

michitux May 26, 2023

Sereza7 Aug 18, 2023

		<span class="wikicreatelink"><a href="$pageDoc.getURL('create')"
		title="$services.localization.render('core.create.inline.label', [$title])">$title</a></span>

		title="$services.localization.render('platform.',
		['#pageLink($translationsReference)']"

		return this.contextLocalization.getTranslationPlain("core.create.inline.label",
		attachmentReference.getName());

XWIKI-19383: Display a title on createlink #2104

Are you sure you want to change the base?

XWIKI-19383: Display a title on createlink #2104

Conversation

Sereza7 commented Mar 6, 2023

Sereza7 commented Mar 16, 2023

Choose a reason for hiding this comment

Sereza7 commented Mar 20, 2023

mflorea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmassol commented Mar 29, 2023

Choose a reason for hiding this comment

vmassol Mar 29, 2023 • edited Loading

Choose a reason for hiding this comment

michitux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmassol Mar 29, 2023 •

edited

Loading