wiki/info/landscape/branding-setup.md
... ...
@@ -34,21 +34,21 @@ As a reference, review the project:
34 34
35 35
1. **Create a new web application project**
36 36
37
- * Navigate to `File → New → Create Web Application Project`
37
+ * Navigate to `Eclipse → File → New → Plug-in Development → Plug-in Project`
38 38
* Place it under the `java` folder in your workspace
39
+ * A branding bundle must register its implementation of `BrandingConfiguration` in the **OSGi Service Registry**. So, provide an `Activator` that registers your Branding Service.
39 40
40 41
2. **Register your bundle**
41 42
42 43
* Add the new bundle to the following files:
43 44
44 45
* `raceanalysis.product`
45
- * Root `pom.xml` (in the `java` folder)
46
+ * `pom.xml` in the `git/java` folder
46 47
* `feature.xml` (within `com.sap.sse.feature`)
47 48
48
-3. **Consult workspace documentation**
49 49
More information about project and bundle requirements can be found here:
50
- `https://wiki.sapsailing.com/wiki/info/landscape/typical-development-scenarios.md#adding-an-osgi-bundle` and
51
- `https://wiki.sapsailing.com/wiki/info/general/workspace-bundles-projects-structure.md`
50
+ [Adding an OSGi bundle](https://wiki.sapsailing.com/wiki/info/landscape/typical-development-scenarios.md#adding-an-osgi-bundle) and
51
+ [Bundles structure](https://wiki.sapsailing.com/wiki/info/general/workspace-bundles-projects-structure.md)
52 52
53 53
---
54 54
... ...
@@ -60,29 +60,12 @@ Create your own configuration class, for example:
60 60
YourBrandNameBrandingConfiguration.java
61 61
```
62 62
63
-This class must **implement** the `BrandingConfiguration` interface (see: `SAPBrandingConfiguration.java`).
63
+This class must **implement** the `BrandingConfiguration` interface (see: `SAPBrandingConfiguration.java`). All current configuration methods' purpose is explained in the Javadoc on the interface itself: see `java/com.sap.sse.branding/src/com/sap/sse/branding/shared/BrandingConfiguration.java` implementation.
64 64
65 65
You can override methods to define your custom branding behavior.
66
-Some methods rely on `sailingServerStringMessages`, which works similarly to message resources.
66
+Some methods rely on `SailingServerStringMessages`, which works similarly to message resources. Provide English and German (de) messages together for any new text added to branding.
67 67
Localization details can be found here:
68
-`https://wiki.sapsailing.com/wiki/howto/development/i18n.md`
69
-
70
-### Overview of Key Configuration Methods
71
-
72
-| Method | Purpose |
73
-| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
74
-| `getId()` | Returns the brand ID (used in system properties). |
75
-| `getDefaultBrandingLogoURL()` | Main logo (headers, favicon, etc.). |
76
-| `getGreyTransparentLogoURL()` | Transparent logo used inside the **Race Tracking** tab. |
77
-| `getBrandTitle()` | Brand display name. |
78
-| `getSolutionsInSailingImageURL()`, `getSailingRaceManagerAppImageURL()`, `getSailInSightAppImageURL()`, etc. | Images shown in the **Solutions** tab. |
79
-| Footer getters (e.g., `getFooterCopyright()`, `getFooterLegalLink()`) | Footer links and copyright. Empty values are hidden. |
80
-| Social getters (e.g., `getSportsOn()`, `getFollowSports()`, `getFacebookLink()`) | Social links on the Home page footer. Optional. |
81
-| `getWelcomeToSailingAnalytics()`, `getWelcomeToSailingAnalyticsBody()` | Welcome widget messages. |
82
-| `getMoreLoginInformationNotificationsURL()`, `getMoreLoginInformationSettingsURL()`, etc. | Popup images for “more login information” (you need to log out in order to test it locally). |
83
-| `getInSailingContent()` | HTML/text under “YourBrandName in Sailing” in the **Solutions** tab (HTML allowed). |
84
-
85
----
68
+[Translation and i18n](https://wiki.sapsailing.com/wiki/howto/development/i18n.md).
86 69
87 70
## 4. Adding New Branding Attributes
88 71
... ...
@@ -155,7 +138,11 @@ StringMessages.INSTANCE.actualStringMessage()
155 138
2. **Search for branding**
156 139
157 140
```text
158
- ss brand
141
+ osgi> ss brand
142
+ Framework is active.
143
+
144
+ id State Bundle
145
+ 108 ACTIVE com.sap.sse.branding.sap (1.2.3)
159 146
```
160 147
161 148
3. **Toggle branding on/off**
... ...
@@ -165,7 +152,7 @@ StringMessages.INSTANCE.actualStringMessage()
165 152
stop 108
166 153
```
167 154
168
- *(ID `108` corresponds to branding.)*
155
+ *(ID `108` corresponds to branding for this example.)*
169 156
170 157
4. **Disconnect**
171 158