Skip to content

Commit

Permalink
Merge branch 'main' for Front Doc only
Browse files Browse the repository at this point in the history
  • Loading branch information
Abel-HenryLapassat committed Dec 17, 2024
2 parents 690be5e + cb57e36 commit 51c6c53
Show file tree
Hide file tree
Showing 9 changed files with 113 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ This part of the documentation follows the following organization and flow:
2 - *Responsive External Objects*; presents how to create and manage responsive, external design elements for seamless integration.
3 - *External Webpages (Native)*; shows and illustrates how to develop specific pages fully connected and integrated into your Simplicité's application.
4 - *External Webpages (Framework*); explains how to do the same as *3* but using web frameworks instead of native configurations.dsfr.
2 - *Responsive External Objects*; presents how to create and manage responsive, external design elements for seamless integration.
3 - *External Webpages (Native)*; shows and illustrates how to develop specific pages fully connected and integrated into your Simplicité's application.
4 - *External Webpages (Framework*); explains how to do the same as *3* but using web frameworks instead of native configurations.dsfr.

### Other relevant lessons

Expand All @@ -80,3 +83,10 @@ This part of the documentation follows the following organization and flow:
* [**Interface tool `$ui` (Documentation)**](https://docs.simplicite.io/lesson/docs/core/ui-tools-code-examples)
* [**Custom Services through External Objects (Documentation)**](https://docs.simplicite.io/lesson/docs/integration/webservices/custom-services)
* [**Ajax API (Documentation)**](https://docs.simplicite.io/lesson/docs/integration/librairies/ajax-api)
* [**External Objects (Tutorial)**](https://docs.simplicite.io/lesson/tutorial/development/external-object)
* [**Responsive UI (Documentation)**](https://docs.simplicite.io/lesson/docs/ui/responsive)
* [**Custom UI disposition (Documentation)**](https://docs.simplicite.io/lesson/docs/core/disposition-code-examples)
* [**Core Javascript (Documentation)**](https://docs.simplicite.io/lesson/docs/core/javascript-code-examples)
* [**Interface tool `$ui` (Documentation)**](https://docs.simplicite.io/lesson/docs/core/ui-tools-code-examples)
* [**Custom Services through External Objects (Documentation)**](https://docs.simplicite.io/lesson/docs/integration/webservices/custom-services)
* [**Ajax API (Documentation)**](https://docs.simplicite.io/lesson/docs/integration/librairies/ajax-api)
3 changes: 3 additions & 0 deletions content/CTG_50_docs/CTG_25_front/LSN_10_theme/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ getting back to the tool itself, it is divided in *three parts*, each hosting an

![](theme-editor-parts.png)

1 - Interface preview
2 - Values menu
3 - DOM path
1 - Interface preview
2 - Values menu
3 - DOM path
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You can specify additional remotes:

Each remote definition use the same syntax as the origin definition.

<h3 id="maven">Maven settings</h3>
### Maven settings <span id="maven"></span>

If required, you can specify additional settings to change the Maven settings generated in the `pom.xml`.

Expand All @@ -145,9 +145,10 @@ If required, you can specify additional settings to change the Maven settings ge
"javaVersion": "<alternative Java version>",
"url": "<alternative instance URL>",
"repositoryUrl": "<alternative Maven repository URL>",
"checkstyle": <true to add the CheckStyle verification at build>,
"jshint": <true to add the JSHint check at build>,
"checkstyleReportFile": "<alternative CheckStyle report file, used if above setting is set>",
"checkstyle": <true to execute the CheckStyle verification at build>,
"jshint": <true to execute the JSHint check at build>,
"eslint": <true to execute the ESLint check at build>,
"stylelint": <true to execute the StyleLint check at build>,
"dependencies": [
{
"groupId": "<additional dependency's group ID>",
Expand All @@ -160,13 +161,13 @@ If required, you can specify additional settings to change the Maven settings ge
}
```

<h3 id="sonar">SonarQube&reg; settings</h3>
### SonarQube&reg; settings <span id="sonar"></span>

If required, you can specify additional settings to change the SonarQube&reg; Maven settings generated in the `pom.xml`.
If required, you can specify additional settings to change the SonarQube&reg; configuration generated in the `pom.xml`.

```json
{
"maven": {
"sonar": {
"projectKey": "<alternative project key>",
"projectName": "<alternative project name>",
"projectVersion": "<alternative project version>",
Expand All @@ -175,7 +176,48 @@ If required, you can specify additional settings to change the SonarQube&reg; Ma
}
```

<h3 id="maven">GPG signature</h3>
### Checkstyle&reg; settings <span id="checkstyle"></span>

If required, you can specify additional settings to change the Checkstyle&reg; configuration generated in the `pom.xml`.

```json
{
"checkstyleConfig": "<default|google|<XML resource name>>",
"checkstyleReportFile": "<report file>"
}
```

### JSHint&reg; settings <span id="jshint"></span>

If required, you can specify additional settings to change the JSHint&reg; configuration.

```json
{
"jshintConfig": "<default|<JSON resource name>>"
}
```

### ESLint&reg; settings <span id="eslint"></span>

If required, you can specify additional settings to change the ESLint&reg; configuration.

```json
{
"eslintConfig": "<default|<Javascript resource name>>"
}
```

### StyleLint&reg; settings <span id="stylelint"></span>

If required, you can specify additional settings to change the StyleLint&reg; configuration.

```json
{
"stylelintConfig": "<default|<JSON resource name>>"
}
```

### GPG signature <span id="gpg"></span>

As of version 5.3 it is possible to enable GPG signature of commits.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,37 +48,6 @@ A custom service is just a plain external object (check [this document](/lesson/

In particular this external object needs to be granted to the user that will be calling it on the API endpoint.

<h3 id="rhino">Rhino</h3>

For a JSON/REST custom service, the **Rhino** implementation of the `MyServiceV1` external object could be something like:

```javascript
// The function to implement is the display method like for any external object
MyService.display = function(params) {
// In this example the output is JSON, the MIME type needs to be forced explicitly
this.setMIMEType(HTTPTool.getMimeTypeWithEncoding(HTTPTool.MIME_TYPE_JSON));
// Note that if MIME type is left to default (HTML), a this.setDecoration(false) is generally required

var method = params.getMethod();
console.log("Call method = " + method);

var req = params.getJSONObject();
console.log("Request body = " + req);

var res = new JSONObject();
if (method == "POST") {
if (req != null) {
res.put("request", req);
res.put("response", "Hello " + req.optString("name", "Unknown"));
} else {
res.put("error", "Call me with a request please!");
}
} else {
res.put("error", "Call me in POST please!");
}
return res.toString();
};
```

<h3 id="java">Java</h3>

Expand Down
2 changes: 1 addition & 1 deletion content/CTG_50_docs/LSN_150_quality/quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The code style is analysed at least at each `master` branch build using the foll

- **Java** using [Checkstyle](https://checkstyle.sourceforge.io)
- **JavaScript** using [ESLint](https://eslint.org)
- **styles** using [Stylelint](https://stylelint.io)
- **styles** using [StyleLint](https://stylelint.io)

Any issue is fixed as soon as detected by the above tools.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ See above

<h3 id="version-5.0.30">5.0.30 (2021-03-16)</h3>

- ESlint/StyleLint fixes
- ESLint/StyleLint fixes
- Custom error pages for all HTTP codes
- Fixed KeyCloak language default

Expand Down
19 changes: 16 additions & 3 deletions content/CTG_99_versions/CTG_10_release-notes/LSN_50_v5-3/v5-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -876,12 +876,25 @@ Post-release <span id="postrelease"></span>
- Backported fix form "more" button toggle to ignore extendable fields of embedded lists
- Backported fix sticky header of list into a collapsed area
### 5.3.58 (UNRELEASED) - maintenance revision <span id="version-5.3.58"></span>
### 5.3.58 (2024-12-13) - maintenance revision <span id="version-5.3.58"></span>
- Improved robustness of partial clear cache reloading for transitions
- Backported unit tests execution over I/O improvements/fixes
- Workaround to fix a Bootstrap 5.3.3 issue on Modal (chrome warning on a forced `aria-hidden=true`)
- Added missing JARs reloading after a "Save all" compilation success in the code editor
- Backported fix colors of ENUM `DOC_LEGAL_STATUS`
- Backported fix REFSELECT context to preserve the copyId + HTML field in read-only
- Backported fix colors of list of values `DOC_LEGAL_STATUS`
- Backported fix refrence select context to preserve the copyId + HTML field in read-only
- Backported improvements on the developments artifacts of the exported/committed module (ESLint for JS code)
- Fixed "no search" option for panel instances
- Backported `USE_DEEPLINKS=no` to disable "Copy link" button on list/form
### 5.3.59 (2024-12-17) - maintenance revision <span id="version-5.3.59"></span>
- Backported improvements on the developments artifacts of the exported/committed module (added StyleLint for CSS/LESS code and improved ESLint for JS)
- Fixed search access when `md.search` is `none`
- Fixed missing enumeration access on menu when the field is read-only
- Fixed missing `USE_DEEPLINKS` backported system parameters in patches
### 5.3.60 (UNRELEASED) - maintenance revision <span id="version-5.3.60"></span>
- Nothing so far...
21 changes: 18 additions & 3 deletions content/CTG_99_versions/CTG_10_release-notes/LSN_70_v6-1/v6-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ ex: home_ajax_DemoOrder_DemoHome_2
- Fixed form "more" button toggle to ignore extendable fields of embedded lists
- Fixed sticky header of list into a collapsed area

### 6.1.17 (UNRELEASED) <span id="version-6.1.17"></span>
### 6.1.17 (2024-12-13) <span id="version-6.1.17"></span>

- Draw read-only enumeration field with tag rendering on form
- Fixed missing front constraints on the publication template form
Expand All @@ -380,5 +380,20 @@ ex: home_ajax_DemoOrder_DemoHome_2
- Fixed ENU translation of "Tray menu"
- Workaround to fix a Bootstrap 5.3.3 issue on Modal (chrome warning on a forced `aria-hidden=true`)
- Added missing JARs reloading after a "Save all" compilation success in the code editor
- Fixed colors of ENUM `DOC_LEGAL_STATUS`
- Fixed REFSELECT context to preserve the copyId + HTML field in read-only
- Fixed colors of list of values `DOC_LEGAL_STATUS`
- Fixed select reference context to preserve the copyId + HTML field in read-only
- Backported refactoring of Google Maps features to use `AdvancedMarkerElement` instead of `Marker`
- Backported improvements on the developments artifacts of the exported/committed module (ESLint for JS code)
- Fixed "no search" option in panel instances

### 6.1.18 (2024-12-17) <span id="version-6.1.18"></span>

- Backported improvements on the developments artifacts of the exported/committed module (added StyleLint for CSS/LESS code and improved ESLint for JS)
- Fixed search access when `md.search` is `none`
- Fixed missing enumeration access on menu when the field is read-only
- Fixed missing `USE_DEEPLINKS` backported system parameters in patches

### 6.1.19 (UNRELEASED) <span id="version-6.1.19"></span>

- Nothing so far...

18 changes: 14 additions & 4 deletions content/CTG_99_versions/LSN_7_roadmap/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
<a href="https://simplicite.notion.site/6c1ec0ab3df249c489782b20625761fd?v=c693a34d0f984a76bdaa6bffc3a1e10c" target="_blank">
<img src="roadmap.png" alt="Roadmap"/>
</a>
<div style="position: relative; width: 100%; height: 100%; overflow: hidden;">
<iframe
src="https://simplicite.notion.site/6c1ec0ab3df249c489782b20625761fd"
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: none;"
onerror="this.style.display='none'; this.nextElementSibling.style.display='block';">
</iframe>
<img
src="roadmap.png"
alt="Roadmap"
style="display: none; position: absolute; top: 0; left: 0; width: 100%; height: 100%; object-fit: cover;">
</div>

For feature requests, please post in [the dedicated category in our forum](https://community.simplicite.io/c/feature-request/46)
Usefull links
- [Roadmap site](https://simplicite.notion.site/6c1ec0ab3df249c489782b20625761fd) on Notion
- Request a Feature [on the forum](https://community.simplicite.io/c/feature-request/46)

0 comments on commit 51c6c53

Please sign in to comment.