XWIKI-22433: Provide consistency in info / warning / error class usages in templates #3555
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -129,7 +129,7 @@ | |
| <div class="XWikiColorThemeDisplayer"> | ||
| #set ($colorThemeExists = $xwiki.exists($services.model.resolveDocument($value))) | ||
| #if ("$!value" != '' && !$colorThemeExists) | ||
| #error(<p>$services.localization.render('admin.colorthemes.invalidtheme', $escapetool.xml($value))</p>) | ||
| #end | ||
|
|
||
| #if ($isSubWiki && (!$flamingoThemesFromMainWiki.isEmpty() || !$colibriThemesFromMainWiki.isEmpty())) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -429,7 +429,7 @@ $xwiki.jsfx.use('js/xwiki/actionbuttons/actionButtons.js', true) | |
| $escapetool.xml($sectionDisplayName) | ||
| </span> | ||
| #if(!$hasAccess) | ||
| <br/>#inlineError($services.localization.render('xe.admin.configurable.sectionIconNoAccess')) | ||
| #end | ||
| </a> | ||
| </li> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -119,7 +119,7 @@ | |
| #displayAnnotationBoxButtons('edit') | ||
| </form> | ||
| #else | ||
| #info($services.localization.render('annotations.action.edit.error.notfound')) | ||
| #end | ||
| </div> | ||
| #end | ||
|
|
@@ -152,7 +152,7 @@ | |
| ##<div class="clearfloats"></div> | ||
| #displayAnnotationFromReference($ann $mode $docRef) | ||
| #else | ||
| #info($services.localization.render('annotations.action.view.error.notfound')) | ||
| #end | ||
| </div> | ||
| #end | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -148,10 +148,10 @@ | |
| </div> | ||
| <div class="clearfloats" /> | ||
| #else | ||
| #info($services.localization.render('annotations.settings.error.wrongsyntax')) | ||
| #end | ||
| #else | ||
| #info($services.localization.render('annotations.settings.error.notarget')) | ||
| #end | ||
| </div> | ||
| {{/html}} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -228,9 +228,7 @@ xcontext.put('propertyCustomDisplayer', new PropertyCustomDisplayer(xcontext)) | |
| ["#pageLink($sheetReference)"]) | ||
| </span> | ||
| #else | ||
| #inlineWarning($services.localization.render('platform.appwithinminutes.classEditorMultipleSheetsWarning')) | ||
| #end | ||
| </dd> | ||
| <dt> | ||
|
|
@@ -705,7 +703,7 @@ xcontext.put('propertyCustomDisplayer', new PropertyCustomDisplayer(xcontext)) | |
| #updateAndSaveTranslations | ||
| #if ($action == 'save') | ||
| #if ($errorMessage) | ||
| #error($errorMessage) | ||
| #elseif ("$!request.wizard" == 'true') | ||
| ## Redirect to next wizard step. | ||
| #set ($className = $stringtool.removeEnd($doc.fullName, 'Class')) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -140,14 +140,10 @@ | |
| </dl> | ||
| #set ($appHomeRef = $services.model.resolveDocument('', 'default', $appReference)) | ||
| #if ($appDescriptor || $xwiki.exists($appHomeRef) || $xwiki.exists($appClassRef)) | ||
| #warning($services.localization.render('platform.appwithinminutes.appNameIsUsedWarning')) | ||
| #end | ||
| #if (!$services.security.authorization.hasAccess('script', $xcontext.userReference, $appHomeRef)) | ||
| #error($escapetool.xml($services.localization.render('platform.appwithinminutes.appHomePageNoScriptRight'))) | ||
| #end | ||
| #end | ||
| #end | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -337,9 +337,7 @@ | |
| #updateAndSaveIcon() | ||
| #if ($action == 'save') | ||
| #if ($errorMessage) | ||
| {{error}}$!escapetool.xml($errorMessage){/error}} | ||
| #else | ||
| ## Redirect to view mode. | ||
| $response.sendRedirect($doc.getURL()) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -183,14 +183,8 @@ | |
| #end | ||
|
|
||
| #macro (renameAppModalBody) | ||
| #info($services.localization.render('appWithinMinutes.renameApp.changeAppTitleInfo')) | ||
| #warning($services.localization.render('appWithinMinutes.renameApp.regenerateAppCodeWarning')) | ||
| <div class="hidden"> | ||
| <input type="hidden" name="form_token" value="$!escapetool.xml($services.csrf.token)" /> | ||
| <input type="hidden" name="oldAppReference" value="$escapetool.xml( | ||
|
|
@@ -242,7 +236,7 @@ | |
| #set ($classFullName = $doc.getValue('class')) | ||
| #if ("$!classFullName" == '' || !$xwiki.exists($classFullName)) | ||
| {{warning}} | ||
| {{translation key="platform.appwithinminutes.appHomePageMovedWarning"/}} | ||
| {{/warning}} | ||
|
|
||
| #end | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,7 +67,5 @@ | |
| #end | ||
| #else | ||
| $response.setStatus(404) | ||
| #error($escapetool.xml($services.localization.render('attachment.move.status.notFound'))) | ||
| #end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -89,7 +89,9 @@ | |
|
|
||
| #set ($indexJobStatus = $services.job.getJobStatus(['extension_security'])) | ||
| #if ($indexJobStatus) | ||
| ## We use the velocity macro here instead of the XWiki macro, in order to keep HTML in the content | ||
| ## With the XWiki macro, the progress bar is not properly rendered. | ||
| #define ($infoMessageContent) | ||
| #if ($indexJobStatus.state != 'FINISHED') | ||
| $escapetool.xml($services.localization.render('extension.security.indexed.started', [$xwiki.formatDate($indexJobStatus.startDate)])) | ||
| #set ($discard = $xwiki.jsfx.use('uicomponents/job/job.js')) | ||
|
|
@@ -101,13 +103,14 @@ | |
| <div class="xcontent job-status" data-url="$escapetool.xml($jobStatusURL)"> | ||
| #displayJobProgressBar($indexJobStatus, true) | ||
| </div> | ||
| #else | ||
| $escapetool.xml($services.localization.render('extension.security.indexed.on', [$xwiki.formatDate($indexJobStatus.startDate)])) | ||
| #end | ||
| #end | ||
| #info($infoMessageContent) | ||
| #else | ||
| {{warning}}$escapetool.xml($services.localization.render('extension.security.indexed.nojob')){{/warning}} | ||
| #end | ||
| {{/html}} | ||
| #end | ||
| {{/velocity}} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -307,9 +307,7 @@ | |
| #set ($parameters = [$count, $htmlLink]) | ||
| {{html wiki='false' clean='false'}} | ||
| <li> | ||
| #error($services.localization.render('extension.security.notification.message', $parameters)) | ||
| </li> | ||
| {{/html}} | ||
| #end | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -116,13 +116,13 @@ | |
|
|
||
| #if ($recommended) | ||
| #if (!$extensions.iterator().hasNext()) | ||
| #warning($services.localization.render('extensions.search.recommended.fallback', ["<em>$!escapetool.xml($request.search)</em>"])) | ||
| ## Search again with the recommended filter | ||
| #set ($extensions = $repository.search("$!request.search", $paginationParams.firstItem, $paginationParams.itemsPerPage)) | ||
| #set ($totalHits = $extensions.totalHits) | ||
| #set ($recommended = false) | ||
| #elseif (!$customExtensionFilter) | ||
| #define ($infoHeaderContent) | ||
| #if ($compatible) | ||
| $services.localization.render('extensions.search.compatiblerecommended.disclaimer') | ||
| #else | ||
|
|
@@ -142,12 +142,13 @@ | |
| <input type="submit" value="${escapetool.xml($services.localization.render('extensions.search.all.label'))}" class="btn btn-default"/> | ||
| #end | ||
| </form> | ||
| #end | ||
| #info("$infoHeaderContent") | ||
| #end | ||
| #end | ||
|
|
||
| #if (!$extensions.iterator().hasNext()) | ||
| #info($services.localization.render($noResultsMessageKey, ["<em>$!escapetool.xml($request.search)</em>"])) | ||
| #else | ||
| #if ($totalHits && $totalHits > $paginationParams.itemsPerPage) | ||
| #set ($hasPagination = true) | ||
|
|
@@ -165,39 +166,46 @@ | |
| #end | ||
|
|
||
| #if ($indexed) | ||
| #define ($formContent) | ||
| <form action="${xwiki.relativeRequestURL}"> | ||
| #if ($request.section) | ||
| <input type="hidden" name="section" value="${escapetool.xml($request.section)}" /> | ||
| #end | ||
| <input type="hidden" name="search" value="$!{escapetool.xml($request.search)}" /> | ||
| <input type="hidden" name="recommended" value="$recommended" /> | ||
| <input type="hidden" name="indexed" value="$indexed" /> | ||
| <input type="hidden" name="compatible" value="$compatible" /> | ||
| #if ($indexJobStatus.state != 'RUNNING') | ||
| <input type="submit" value="${escapetool.xml($services.localization.render('extensions.search.indexed.reindex'))}" name="index_start" class="btn btn-default"/> | ||
| #end | ||
| </form> | ||
| #end | ||
| #set ($indexJobStatus = $repository.getStatus("wiki:${xcontext.database}")) | ||
| #if ($indexJobStatus) | ||
| #if ($indexJobStatus.state != 'FINISHED') | ||
| #set ($discard = $xwiki.jsfx.use('uicomponents/job/job.js')) | ||
| #set ($jobStatusURL = $doc.getURL('get', $escapetool.url({ | ||
| 'xpage': 'job_status_json', | ||
| 'outputSyntax': 'plain', | ||
| 'jobId': $indexJobStatus.request.id | ||
| }))) | ||
| #define ($infoFooterContent) | ||
| $escapetool.xml($services.localization.render('extensions.search.indexed.started', [$xwiki.formatDate($indexJobStatus.startDate)])) | ||
| <div class="xcontent job-status" data-url="$escapetool.xml($jobStatusURL)"> | ||
| #displayJobProgressBar($indexJobStatus, true) | ||
| </div> | ||
| #end | ||
| #else | ||
| #define ($infoFooterContent) | ||
| $escapetool.xml($services.localization.render('extensions.search.indexed.on', [$xwiki.formatDate($indexJobStatus.startDate)])) | ||
| #end | ||
| #end | ||
| #info("$infoFooterContent | ||
| $formContent") | ||
|
There was a problem hiding this comment. hmmm you should really add a comment if the carriage return is on purpose here There was a problem hiding this comment. I just checked it again and it doesn't seem to me like this is needed. I just figured out it wouldn't hurt since it's HTML syntax, and it makes it a bit more readable. |
||
| #else | ||
| #warning("$escapetool.xml($services.localization.render('extensions.search.indexed.nojob')) | ||
| $formContent") | ||
| #end | ||
| #end | ||
| #end | ||
| </div> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,13 +43,11 @@ | |
| #set($finished = $jobStatus.state.name() == 'FINISHED') | ||
| #if ($finished) | ||
| #if (!$jobStatus.logTail.hasLogLevel('ERROR')) | ||
| ## Remove when the following issue is resolved: | ||
| ## TODO XWIKI-22710: Add translations for FilterStreamJobJSON | ||
| #success('Done.') | ||
|
There was a problem hiding this comment. We're missing translations in that file it seems. Might worth adding a comment / creating ticket if there's none. There was a problem hiding this comment. Addressed in 87fe4a4 👍 |
||
| #else | ||
| #error('Error has been found during the conversion !') | ||
| #end | ||
| #end | ||
| #end | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -292,9 +292,7 @@ | |
| #end | ||
| #else | ||
| $response.setStatus(404) | ||
| #error($services.localization.render('core.copy.status.notFound')) | ||
| #end | ||
| #end | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,6 +30,21 @@ | |
| * Displays a class name without its space prefix. XML-escapes the output. | ||
| *# | ||
| #macro(cleanClassname $classname)$!{escapetool.xml($classname.substring($classname.indexOf('.')).substring(1))}#end | ||
|
|
||
| #* | ||
| * Displays a warning box, with an extra class. Note that the implementation of this macro should be very close to the | ||
| * one of the #warning macro defined in the web templates macros. | ||
| * This is the only place where we use this extraClass feature, so the implementation is contained here. | ||
| * Note that the exact context this content is rendered in is not fixed, using the XWiki macro | ||
| * would have ended up in unstable behaviour. | ||
| *# | ||
| #macro (_warningWithExtraClass $text $extraClass) | ||
| <div class="box warningmessage ${extraClass}"> | ||
| <span class="icon-block">$services.icon.renderHTML('warning')</span> | ||
| <span class="sr-only">$services.localization.render('warning')</span> | ||
| $text | ||
| </div> | ||
| #end | ||
| ## | ||
| #* | ||
| * Display an object | ||
|
|
@@ -79,7 +94,7 @@ | |
| </dl> | ||
| #set ($deprecatedProperties = $class.getDeprecatedObjectProperties($obj)) | ||
| #if ($deprecatedProperties.size() > 0) | ||
| #define ($warningMessageContent) | ||
| <strong>$services.localization.render('core.editors.object.removeDeprecatedProperties.info', [${escapetool.xml($class.name)}])</strong> | ||
| <dl> | ||
| #foreach ($prop in $deprecatedProperties) | ||
|
|
@@ -94,7 +109,8 @@ | |
| $services.localization.render('core.editors.object.removeDeprecatedProperties.link') | ||
| </a> | ||
| </div> | ||
| #end | ||
| #warningWithExtraClass($warningMessageContent 'deprecatedProperties') | ||
| #end | ||
| </div> | ||
| #end | ||
|
|
@@ -245,10 +261,11 @@ | |
| #if ($mustSync) #break #end | ||
| #end | ||
| #if ($mustSync) | ||
| #define ($warningMessageContent) | ||
| $services.localization.render('core.editors.object.removeDeprecatedProperties.all.info') | ||
| <div><a class="syncProperties syncAllProperties" href="$doc.getURL('objectsync')" title="$services.localization.render('core.editors.object.removeDeprecatedProperties.all.link.tooltip')">$services.localization.render('core.editors.object.removeDeprecatedProperties.all.link')</a></div> | ||
| #end | ||
| #warningWithExtraClass($warningMessageContent 'deprecatedProperties') | ||
| #end | ||
| #end ## checkPropertyDeprecation | ||
| ## | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -248,7 +248,7 @@ | |
| #livetable_filters($collist $colprops $classname) | ||
| <tr class="xwiki-livetable-initial-message"> | ||
| <td colspan="${columnCount}"> | ||
| #warning($services.localization.render('platform.livetable.environmentCannotLoadTableMessage')) | ||
| </td> | ||
| </tr> | ||
| </thead> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -94,7 +94,5 @@ | |
| #end | ||
| #else | ||
| $response.setStatus(404) | ||
| #error($services.localization.render('core.rename.status.notFound')) | ||
| #end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need this xform here? for style only? My understanding is that the goal of the ticket was to simplify the usages of errormessage, so it feels a bit too complex than it should here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, I want to minimize the changes in the actual content produced in order to minimize breaking customization and other features. I forgot the exact context here, but I don't want to break the form (style and functionality) just because I removed a class. Having this class is supported by the XWiki macro, so I figured it was okay to refactore things like that.
The goal of the PR is to factorize their code. This way, next time we update the message boxes, there won't be inconsistencies popping up everywhere (and this also fixes inconsistencies that popped up since we added icons with XWIKI-21452 :) ).
$${\color{orange}ONGOING}$$
In order to do so, in all of the scripts here, I either use the new velocimacro, or the XWiki macro if possible.