-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmanifest.html
327 lines (307 loc) · 13.2 KB
/
manifest.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<!DOCTYPE html>
<!--
Generated by Apache Maven Doxia 2.0.0
Rendered using Reflow Maven Skin 1.3.4 (https://github.com/wcm-io/wcm-io-tooling/tree/develop/maven/skins/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<title>Manifest | wcm.io</title>
<link rel="shortcut icon" href="https://wcm.io/images/favicon.ico">
<link rel="apple-touch-icon" href="https://wcm.io/images/favicon-152.png">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="wcm.io - Libraries and extensions for AEM applications" />
<meta http-equiv="content-language" content="en" />
<link href="https://wcm.io/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://wcm.io/css/docs.css" rel="stylesheet" />
<link href="https://wcm.io/css/reflow-skin.css" rel="stylesheet" />
<link href="https://wcm.io/css/highlightjs-style-github.min.css" rel="stylesheet" />
<link href="https://wcm.io/css/lightbox.css" rel="stylesheet" />
<link href="https://wcm.io/css/site.css" rel="stylesheet" />
<link href="https://wcm.io/css/print.css" rel="stylesheet" media="print" />
</head>
<body class="page-manifest project-public_site" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target" id="body">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="./">wcm.io</a>
<div class="nav-collapse collapse" id="top-nav-collapse">
<ul class="nav pull-right">
<li ><a href="https://github.com/wcm-io" title="GitHub project" class="externalLink">GitHub project</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Categories <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="wcm/" title="WCM">WCM</a></li>
<li ><a href="caconfig/" title="Context-Aware Configuration">Context-Aware Configuration</a></li>
<li ><a href="handler/" title="Handler">Handler</a></li>
<li ><a href="sling/" title="Sling Extensions">Sling Extensions</a></li>
<li ><a href="testing/" title="Testing">Testing</a></li>
<li ><a href="samples/" title="Samples">Samples</a></li>
<li ><a href="tooling/" title="Tooling">Tooling</a></li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="contribute.html" title="Contribute">Contribute</a></li>
<li class="active"><a href="" title="Manifest">Manifest</a></li>
<li ><a href="https://github.com/wcm-io" title="Issues" class="externalLink">Issues</a></li>
<li ><a href="https://wcm-io.atlassian.net/wiki/" title="Wiki" class="externalLink">Wiki</a></li>
<li ><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
<li ><a href="https://github.com/wcm-io" title="Fork on GitHub" class="externalLink">Fork on GitHub</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<!-- Masthead
================================================== -->
<header>
<div class="jumbotron subhead">
<div class="row" id="banner">
<div class="span12">
<div class="pull-left">
<a href="./" id="bannerLeft"><h1><img src='https://wcm.io/images/[email protected]'/> wcm.io</h1></a>
<p class="lead">Libraries and extensions for AEM applications</p>
</div>
<div class="pull-right">
</div>
</div>
</div>
</div>
</header>
<div class="main-body">
<div class="row">
<div class="span8">
<div class="body-content">
<section>
<section>
<a id="Manifest"></a>
<div class="page-header">
<h2 id="manifest">Manifest</h2>
</div>
<p>This is our manifest for all modules developed in this project.</p>
<section>
<a id="Semantic_Versioning"></a>
<h3 id="semantic_versioning">Semantic Versioning</h3>
<ul>
<li>All wcm.io modules are released following the <a href="https://www.osgi.org/wp-content/uploads/SemanticVersioning.pdf" class="externalLink">Semantic versioning</a> rules.</li>
<li>This applies to both package versions and bundle versions.</li>
<li>We use the same even-odd Versioning strategy as the Apache Sling project (releases always use a even version number for the third digit).</li>
</ul>
</section>
<section>
<a id="Support_multi_tenancy_and_configuration"></a>
<h3 id="support_multi_tenancy_and_configuration">Support multi tenancy and configuration</h3>
<ul>
<li>No configuration is just “global”, but can be applied on any configuration level</li>
</ul>
</section>
<section>
<a id="Minimal_configuration_and_sensible_defaults"></a>
<h3 id="minimal_configuration_and_sensible_defaults">Minimal configuration and sensible defaults</h3>
<ul>
<li>All features should usable “out-of-the-box” without the need of a lot of initial configuration and setup procedures</li>
<li>Sensible defaults are applied for all configuration options</li>
<li>Optionally relevant features can be configured and extended</li>
</ul>
</section>
<section>
<a id="Good_API_Design"></a>
<h3 id="good_api_design">Good API Design</h3>
<ul>
<li>Good API design leveraging best practices e.g. How To Design A Good API and Why it Matters (Joshua Bloch), Effective Java 2nd Edition (Joshua Bloch), Clean Code (Robert Martin)</li>
<li>Export only APIs and SPIs in OSGi, not the implementation</li>
<li>Enforce separation of concerns</li>
</ul>
</section>
<section>
<a id="Internationalization"></a>
<h3 id="internationalization">Internationalization</h3>
<ul>
<li>Every user-visible part has to use i18n for translations (author and publish environment)</li>
<li>By default we ship with English and German translations</li>
</ul>
</section>
<section>
<a id="Testability"></a>
<h3 id="testability">Testability</h3>
<ul>
<li>Design and implement everything for good testability - unit tests, integration tests, acceptance tests</li>
</ul>
</section>
<section>
<a id="AEM_Product_Dependencies"></a>
<h3 id="aem_product_dependencies">AEM Product Dependencies</h3>
<ul>
<li>Targeted at AEM 6 and up</li>
<li>Targeted primary at the Touch UI, only basic support for Classic UI</li>
</ul>
</section>
<section>
<a id="AEM_Update-Safeness"></a>
<h3 id="aem_update-safeness">AEM Update-Safeness</h3>
<ul>
<li>No overlays!</li>
<li>Do not come into way when upgrading AEM versions or deploying service packs</li>
<li>Test early with new AEM major versions</li>
</ul>
</section>
</section>
</section>
</div>
</div>
<div class="span4">
<div id="toc-sidebar">
<div class="well">
<ul class="nav nav-list">
<li class="nav-header">Table of Contents</li>
<li class="dropdown"><a href="#manifest" title="Manifest">Manifest <b class="caret"></b></a>
<ul class="nav nav-list">
<li><a href="#semantic_versioning" title="Semantic Versioning">Semantic Versioning</a>
<li><a href="#support_multi_tenancy_and_configuration" title="Support multi tenancy and configuration">Support multi tenancy and configuration</a>
<li><a href="#minimal_configuration_and_sensible_defaults" title="Minimal configuration and sensible defaults">Minimal configuration and sensible defaults</a>
<li><a href="#good_api_design" title="Good API Design">Good API Design</a>
<li><a href="#internationalization" title="Internationalization">Internationalization</a>
<li><a href="#testability" title="Testability">Testability</a>
<li><a href="#aem_product_dependencies" title="AEM Product Dependencies">AEM Product Dependencies</a>
<li><a href="#aem_update-safeness" title="AEM Update-Safeness">AEM Update-Safeness</a>
<li class="divider"></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Footer
================================================== -->
<footer class="well">
<div class="container">
<div class="row">
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Main</li>
<li >
<a href="./" title="Home">Home</a>
</li>
<li >
<a href="platforms.html" title="Platforms">Platforms</a>
</li>
<li >
<a href="maven.html" title="Maven Repositories">Maven Repositories</a>
</li>
<li >
<a href="https://github.com/wcm-io" title="GitHub project" class="externalLink">GitHub project</a>
</li>
<li >
<a href="subprojects.html" title="Subprojects">Subprojects</a>
</li>
<li >
<a href="http://www.apache.org/licenses/LICENSE-2.0.txt" title="License" class="externalLink">License</a>
</li>
<li >
<a href="commercial-support.html" title="Commercial Support">Commercial Support</a>
</li>
<li >
<a href="https://diva-e.com/en/imprint/" title="Imprint" class="externalLink">Imprint</a>
</li>
<li >
<a href="privacy.html" title="Privacy Policy">Privacy Policy</a>
</li>
</ul>
</div>
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Categories</li>
<li >
<a href="wcm/" title="WCM">WCM</a>
</li>
<li >
<a href="caconfig/" title="Context-Aware Configuration">Context-Aware Configuration</a>
</li>
<li >
<a href="handler/" title="Handler">Handler</a>
</li>
<li >
<a href="sling/" title="Sling Extensions">Sling Extensions</a>
</li>
<li >
<a href="testing/" title="Testing">Testing</a>
</li>
<li >
<a href="samples/" title="Samples">Samples</a>
</li>
<li >
<a href="tooling/" title="Tooling">Tooling</a>
</li>
</ul>
</div>
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Contribute</li>
<li >
<a href="contribute.html" title="Contribute">Contribute</a>
</li>
<li class="active">
<a href="#" title="Manifest">Manifest</a>
</li>
<li >
<a href="https://github.com/wcm-io" title="Issues" class="externalLink">Issues</a>
</li>
<li >
<a href="https://wcm-io.atlassian.net/wiki/" title="Wiki" class="externalLink">Wiki</a>
</li>
<li >
<a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li >
<a href="https://github.com/wcm-io" title="Fork on GitHub" class="externalLink">Fork on GitHub</a>
</li>
</ul>
</div>
<div class="span3 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Maven documentation</li>
<li >
<a href="project-info.html" title="Project Information">Project Information <i class="icon-chevron-right"></i></a>
</li>
</ul>
</div>
<div class="span3 bottom-description">
<blockquote>wcm.io is an Open Source project which provides libraries and extensions for AEM-based applications.</blockquote>
</div>
</div>
</div>
</footer>
<div class="container subfooter">
<div class="row">
<div class="span12">
<p class="pull-right"><a href="#body">Back to top</a></p>
<p class="copyright">Copyright ©2014-2025 <a href="https://wcm.io">wcm.io</a>. All Rights Reserved.</p>
<p class="version-date"><span class="projectVersion">Version: 1. </span><span class="publishDate">Last Published: 2025-04-12. </span></p>
</div>
</div>
</div>
<!-- JavaScript
================================================== -->
<script src="https://wcm.io/js/jquery.min.js"></script>
<script src="https://wcm.io/js/bootstrap.min.js"></script>
<script src="https://wcm.io/js/lightbox.min.js"></script>
<script src="https://wcm.io/js/reflow-scroll.js"></script>
<script src="https://wcm.io/js/json5.min.js"></script>
<script src="https://wcm.io/js/reflow-json-jcr-convert.js"></script>
<script src="https://wcm.io/js/highlight.min.js"></script>
<script src="https://wcm.io/js/reflow-skin.js"></script>
</body>
</html>