You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2017/04/17 10:32:21 UTC
[27/43] isis git commit: ISIS-1521: adds hints-n-tips sections for
most of the user guides, and distributes out tips from dg.adoc as appropriate
http://git-wip-us.apache.org/repos/asf/isis/blob/7295f71a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
new file mode 100644
index 0000000..54b83d7
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
@@ -0,0 +1,26 @@
+[[_ugvw_hints-and-tips_i18n-label-in-wicket-viewer]]
+= How i18n the Wicket viewer?
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../../
+:_imagesdir: images/
+
+
+
+From link:http://isis.markmail.org/thread/ctppmtcbsf4iskzi[this thread] on the Apache Isis users mailing list:
+
+* _I am trying to internationalize the label descriptions of form actions, eg those in `ActionParametersFormPanel`.
+Referencing those via their message id inside a .po file didn't work either.
+Can this be done?_
+
+
+The above FAQ was raised against `1.10.0`. As of `1.11.0` (due to link:https://issues.apache.org/jira/browse/ISIS-1093[ISIS-1093]) it _is_ now possible to internationalize both the Wicket viewer's labels as well as the regular translations of the domain object metadata using the `.po` translation files as supported by the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
+
+Full details of the ``msgId``s that must be added to the `translations.po` file can be found in xref:guides/ugbtb.adoc#__ugbtb_i18n_wicket-viewer[i18n] section of the xref:../ugbtb/ugbtb.adoc#[beyond the basics] guide.
+
+In prior releases (`1.10.0` and earlier) it was necessary to use link:https://ci.apache.org/projects/wicket/guide/6.x/guide/i18n.html#i18n_3[Wicket's internationalization support], namely resource bundles. This is still supported (as a fallback):
+
+* create a directory structure inside the webapp resource folder following that pattern `org.apache.isis.viewer.wicket.ui.components.actions`
+
+* Inside there create an equivalent `ActionParametersFormPanel_xx_XX.properties` or `ActionParametersFormPanel_xx.properties` file for the various locales that you want to support (eg `ActionParametersFormPanel_en_UK.properties`, `ActionParametersFormPanel_en_US.properties`, `ActionParametersFormPanel_de.properties` and so on).
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/7295f71a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
new file mode 100644
index 0000000..43c8835
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
@@ -0,0 +1,91 @@
+[[_ugvw_hints-and-tips_per-user-themes]]
+= Per-user Themes
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../../
+:_imagesdir: images/
+
+
+From link:http://isis.markmail.org/thread/kb4442niwwbnghey[this thread] on the Apache Isis users mailing list:
+
+* _Is it possible to have each of our resellers (using our Isis application) use there own theme/branding with their own logo and colors?
+Would this also be possible for the login page, possibly depending on the used host name?_
+
+
+Yes, you can do this, by installing a custom implementation of the Wicket Bootstrap's `ActiveThemeProvider`.
+
+The http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp] (non-ASF) actually link:https://github.com/isisaddons/isis-app-todoapp/tree/61b8114a8e01dbb3c380b31cf09eaed456407570[does this], storing the info via the http://github.com/isisaddons/isis-module-settings[Isis addons' settings module] settings modules:
+
+
+[source,java]
+.IActiveThemeProvider implementation
+----
+public class UserSettingsThemeProvider implements ActiveThemeProvider {
+ ...
+ @Override
+ public ITheme getActiveTheme() {
+ if(IsisContext.getSpecificationLoader().isInitialized()) {
+ final String themeName = IsisContext.doInSession(new Callable<String>() {
+ @Override
+ public String call() throws Exception {
+ final UserSettingsService userSettingsService =
+ lookupService(UserSettingsService.class);
+ final UserSetting activeTheme = userSettingsService.find(
+ IsisContext.getAuthenticationSession().getUserName(),
+ ACTIVE_THEME);
+ return activeTheme != null ? activeTheme.valueAsString() : null;
+ }
+ });
+ return themeFor(themeName);
+ }
+ return new SessionThemeProvider().getActiveTheme();
+ }
+ @Override
+ public void setActiveTheme(final String themeName) {
+ IsisContext.doInSession(new Runnable() {
+ @Override
+ public void run() {
+ final String currentUsrName =
+ IsisContext.getAuthenticationSession().getUserName();
+ final UserSettingsServiceRW userSettingsService =
+ lookupService(UserSettingsServiceRW.class);
+ final UserSettingJdo activeTheme =
+ (UserSettingJdo) userSettingsService.find(
+ currentUsrName, ACTIVE_THEME);
+ if(activeTheme != null) {
+ activeTheme.updateAsString(themeName);
+ } else {
+ userSettingsService.newString(
+ currentUsrName, ACTIVE_THEME, "Active Bootstrap theme for user", themeName);
+ }
+ }
+ });
+ }
+ private ITheme themeFor(final String themeName) {
+ final ThemeProvider themeProvider = settings.getThemeProvider();
+ if(themeName != null) {
+ for (final ITheme theme : themeProvider.available()) {
+ if (themeName.equals(theme.name()))
+ return theme;
+ }
+ }
+ return themeProvider.defaultTheme();
+ }
+ ...
+}
+----
+
+and
+
+[source,java]
+.Using the ActiveThemeProvider
+----
+@Override
+protected void init() {
+ super.init();
+
+ final IBootstrapSettings settings = Bootstrap.getSettings();
+ settings.setThemeProvider(new BootswatchThemeProvider(BootswatchTheme.Flatly));
+
+ settings.setActiveThemeProvider(new UserSettingsThemeProvider(settings));
+}
+----
http://git-wip-us.apache.org/repos/asf/isis/blob/7295f71a/adocs/documentation/src/main/asciidoc/guides/ugvw/ugvw.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/ugvw.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/ugvw.adoc
index 4ddba0d..fde7dbc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/ugvw.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/ugvw.adoc
@@ -53,8 +53,8 @@ include::_ugvw_features.adoc[leveloffset=+1]
include::_ugvw_configuration-properties.adoc[leveloffset=+1]
include::_ugvw_layout.adoc[leveloffset=+1]
include::_ugvw_customisation.adoc[leveloffset=+1]
-
include::_ugvw_extending.adoc[leveloffset=+1]
+include::_ugvw_hints-and-tips.adoc[leveloffset=+1]
include::_ugvw_isis-addons.adoc[leveloffset=+1]