Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Eclipse Scout » [Neon] Naming convention & demo App
[Neon] Naming convention & demo App [message #1722042] Tue, 02 February 2016 12:39 Go to next message
Jeremie Bresson is currently offline Jeremie BressonFriend
Messages: 1252
Registered: October 2011
Senior Member
The team has decided to write down the naming convention rules for the scout applications. You are free to follow it or not, but we wanted to share it here.

Each project follow this rule: <app-name><module><suffix> where:

1) app.name is the name of the application:

  • myapp
  • com.company.someapp
  • org.eclipse.scout.widgets
  • org.eclipse.scout.contacts


2) module is the part of the application

  • "" (empty String for the main module. You can also decide to call it "core")
  • A business identifier of your module:

    • "heatmap" (example from the Widgets demo app containing the heatmap custom field)
    • "events" (example from the Contacts demo app to add some event management an additional view)



3) Suffix oder tier (oder was der Name ist)

  • client
  • client.mobile
  • shared
  • server
  • ui.html
  • ui.html.app.dev
  • ui.html.app.war


The parent pom project is called <app-name> (and not <app-name>.parent for example).

Your feedback is welcome.

Report message to a moderator

Re: [Neon] Naming convention & demo App [message #1722046 is a reply to message #1722042] Tue, 02 February 2016 13:35 Go to previous message
Jeremie Bresson is currently offline Jeremie BressonFriend
Messages: 1252
Registered: October 2011
Senior Member
We will appply those new rules on our Demo Applications and rename the projects:

contacts demo app
* "org.eclipse.scout.contacts.client.module.events " -> "org.eclipse.scout.contacts.events.client",
* "org.eclipse.scout.contacts.server.module.events " -> "org.eclipse.scout.contacts.events.server",
* "org.eclipse.scout.contacts.shared.module.events " -> "org.eclipse.scout.contacts.events.shared"

widgets demo app
* "org.eclipsescout.demo.widgets" -> "org.eclipse.scout.widgets",
* "org.eclipsescout.demo.widgets.client" -> "org.eclipse.scout.widgets.client",
* "org.eclipsescout.demo.widgets.client.custom" -> "org.eclipse.scout.widgets.heatmap.client",
* "org.eclipsescout.demo.widgets.client.mobile" -> "org.eclipse.scout.widgets.client.mobile",
* "org.eclipsescout.demo.widgets.client.old" -> "org.eclipse.scout.widgets.old.client",
* "org.eclipsescout.demo.widgets.shared" -> "org.eclipse.scout.widgets.shared",
* "org.eclipsescout.demo.widgets.shared.old" -> "org.eclipse.scout.widgets.old.shared",
* "org.eclipsescout.demo.widgets.shared.custom" -> "org.eclipse.scout.widgets.heatmap.shared",
* "org.eclipsescout.demo.widgets.ui.html" -> "org.eclipse.scout.widgets.ui.html",
* "org.eclipsescout.demo.widgets.ui.html.custom" -> "org.eclipse.scout.widgets.heatmap.ui.html",
* "org.eclipsescout.demo.widgets.ui.html.app.dev" -> "org.eclipse.scout.widgets.ui.html.app.dev",
* "org.eclipsescout.demo.widgets.ui.html.app.war" -> "org.eclipse.scout.widgets.ui.html.app.war"

Report message to a moderator

Previous Topic:[Neon] Serving images from the Scout Client
Next Topic:[Neon] Client polling
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ]

Current Time: Fri Apr 26 17:20:18 GMT 2024

Powered by FUDForum. Page generated in 0.03961 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top

Sign up to our Newsletter

A fresh new issue delivered monthly