Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XWIKI-21633: Adding a step tour on a class field doesn't work #3781

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

XWIKI-21633: Adding a step tour on a class field doesn't work #3781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89753ae
XWIKI-21633: Adding a step tour on a class field doesn't work
Sereza7 Dec 27, 2024
d8aade5
XWIKI-21633: Adding a step tour on a class field doesn't work
Sereza7 Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion ...core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/StepSheet.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,12 @@
</dl>
#else
<dl>
<dt><label #if($isEditing)for="TourCode.StepClass_0_${prop.name}"#end>$services.localization.render("${class.name}_${prop.name}")</label></dt>
<dt><label #if($isEditing)for="TourCode.StepClass_0_${prop.name}"#end>$services.localization.render("${class.name}_${prop.name}")</label>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strange indentation. And I would call $escapetool.xml() on the label.

## Add a hint for the field if there's one defined in the translations.
#if($!services.localization.render("${class.name}_${prop.name}.hint") != "${class.name}_${prop.name}.hint")##
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also use $services.localization.get() to check if a key is translated, see https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-mentions/xwiki-platform-mentions-notifications/src/main/resources/templates/mentions/mention.vm#L85-L89 .

<span class='xHint'>$!services.localization.render("${class.name}_${prop.name}.hint")</span>##
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class='xHint'>$!services.localization.render("${class.name}_${prop.name}.hint")</span>##
<span class='xHint'>$!escapetool.xml($services.localization.render("${class.name}_${prop.name}.hint"))</span>##

#end##
</dt>
<dd>$vobj.get($prop.getName())</dd>
</dl>
#end
Expand Down
3 changes: 3 additions & 0 deletions ...rm-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,10 @@ require(['jquery', 'xwiki-meta'], function ($, xm) {
createTour(tour);
}
}
}).fail(function (data) {
console.error("Querying the JSON for the Tour failed. %o", data);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what's the benefit for this, since the browser's web developer tools already provide information about the failed HTTP requests.

});
;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks unnecessary.

});
});</code>
</property>
Expand Down
2 changes: 1 addition & 1 deletion ...-core/xwiki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourJson.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<hidden>true</hidden>
<content>{{include reference="TourCode.Macros"/}}

{{velocity}}
{{velocity wiki="false"}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the indentation? And BTW, you could instead set output="false" and call the #jsonResponse() Velocity macro at the end to write the JSON directly to the HTTP response.

#if ($xcontext.action == 'get')
##--------------------------------------------------------
## Get the tour steps corresponding to the target page
Expand Down
1 change: 1 addition & 0 deletions ...iki-platform-tour/xwiki-platform-tour-ui/src/main/resources/TourCode/TourTranslations.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ tour.popover.show.hint=You can restart the tour by clicking this button at anyti
# Steps
TourCode.StepClass_order=Order
TourCode.StepClass_element=Element (CSS selector that identify an element)
TourCode.StepClass_element.hint=CSS selector that identifies an element. Escape special CSS characters with a backslash.
TourCode.StepClass_title=Title
TourCode.StepClass_content=Content
TourCode.StepClass_backdrop=Backdrop
Expand Down