Responsive Aurora starter store file structure

The Responsive Aurora starter store files are organized in a defined structure by default. The file structure contains layouts, containers, widgets, CSS stylesheets, marketing content, and device-specific assets.

The following file structure exists when the Responsive Aurora starter store is published:

Layouts and containers

WC_eardir/Stores.war/storedir/ShoppingArea
This directory contains JSP files that use the Commerce Composer framework to render its content.
These files contain the following characteristics and functions:
  • Includes the HTML boilerplate. For example, by using the <html>, <head>, and <body> tags.
  • Links to page-level stylesheets.
  • Includes page-level JavaScript files.
  • Fetches page designs that use the <wcf:getData> tag.
  • Includes JavaScript files that are referenced by widgets that use the <wcpgl:jsInclude> tag.
  • Imports the root widget (container) that uses the <wcpgl:widgetImport> tag.
  • Imports header and footer widgets
  • Links to the WC_eardir/Stores.war/storedir/css/styles.css file, or its RTL (read as right-to-left) version for bidi languages.
  • Contains optimizations for mobile devices.
WC_eardir/Stores.war/storedir/Container
This directory contains container JSP files.
These files contain the following characteristics and functions:
  • Each JSP file is referenced by a container definition in the PLWIDGETDEF table.
  • Responsible for dividing a page into slots and importing the widgets that are assigned to each slot by using the <wcpgl:widgetImport> tag.
  • Does not include the HTML boilerplate.
  • Imported by layout JSP files that use the <wcpgl:widgetImport> tag.
  • Uses the fluid grid system.
  • Does not include any stylesheet or inline styles.
  • Relies on the page-level stylesheet WC_eardir/Stores.war/storedir/css/styles.css file, or its RTL version, for the fluid grid system.

Site-level widgets

WC_eardir/Stores.war/widgetdir/widget_identifier/widget_name.jsp
These individual files are widget JSP files.
It is typically responsible only for including the widget data and user interface JSPF files.
These files contain the following characteristics and functions:
  • Referenced by widget definitions in the PLWIDGETDEF table.
  • Imported by container JSP files that use the <wcpgl:widgetImport> tag.
WC_eardir/Stores.war/widgetdir/widget_identifier/widget_name_Data.jspf
This file contains the widget data.
It is typically responsible for fetching data that uses the <wcf:getData> or <wcf:rest> tags for widget user interface JSPF file consumption.
WC_eardir/Stores.war/widgetdir/widget_identifier/widget_name_UI.jspf
This file contains the widget user interface.
It is typically responsible for formatting data fetched by widget data that uses a JSPF file for presentation. Some widgets might contain multiple widget user interface JSPF files for different scenarios.
This file contains the following characteristics and functions:
  • Does not include any stylesheet or inline styles.
  • Relies on the page-level stylesheet WC_eardir/Stores.war/storedir/css/styles.css file, or its RTL version, for styling.
  • Relies on page or widget-level JavaScript files for dynamic behavior.
  • Contains optimizations for mobile devices.
WC_eardir/Stores.war/widgetdir/widget_identifier/javascript
Optional: This directory contains widget-level JavaScript files.
These files contain the following characteristics and functions:
  • Referenced by widget definitions in the PLWIDGETDEF table.
  • Included by layout JSP files that use the <wcpgl:jsInclude> tag.
  • Updated to support touch events, where applicable.
  • Contains optimizations for mobile devices.
WC_eardir/Stores.war/widgetdir/Properties/widgettext.propertiesWC_eardir/Stores.war/widgetdir/Properties/widgettext_locale.properties
These properties files contain the NL text for site-level widgets.

Store-level widgets

WC_eardir/Stores.war/storedir/Widgets/widget_identifier/widget_name.jsp
These individual files are widget JSP files.
It is typically responsible only for including the widget data and user interface JSPF files.
These files contain the following characteristics and functions:
  • Unlike the site-level widgets, it is not referenced by widget definitions in the PLWIDGETDEF table.
  • Imported by container and widget user interface JSP files that use the <c:import> tag.
WC_eardir/Stores.war/storedir/Widgets/widget_identifier/widget_name_Data.jspf
This file contains the widget data.
It is typically responsible for fetching data that uses the <wcf:getData> tag for widget user interface JSPF file consumption.
WC_eardir/Stores.war/storedir/Widgets/widget_identifier/widget_name_UI.jspf
This file contains the widget user interface.
It is typically responsible for formatting data fetched by widget data, that uses a JSPF file for presentation. Some widgets might contain multiple widget user interface JSPF files for different scenarios.
This file contains the following characteristics and functions:
  • Does not include any stylesheet or inline styles.
  • Relies on the page-level stylesheet WC_eardir/Stores.war/storedir/css/styles.css file, or its RTL version, for styling.
  • Relies on page-level JavaScript files for dynamic behavior.
  • Contains optimizations for mobile devices.
WC_eardir/Stores.war/storedir/javascript/Widgets
WC_eardir/Stores.war/storedir/javascript/Widgets/widget_identifier
Optional: This directory contains widget JavaScript files.
These files contain the following characteristics and functions:
  • Included by layout JSP files that use the <wcpgl:jsInclude> tag.
  • Updated to support touch events, where applicable.
WC_eardir/Stores.war/WEB-INF/classes/storedir/storetext_v2.properties
WC_eardir/Stores.war/WEB-INF/classes/storedir/storetext_v2_locale.properties
These properties files contain the NL text for store-level widgets.

CSS stylesheets

WC_eardir/Stores.war/storedir/css/base.css
This file is the stylesheet for CSS rules common to all store pages.
It contains the fluid grid system.
It is not linked by any JSP files.
It is imported by the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/styles.css
  • WC_eardir/Stores.war/storedir/css/common1_1.css
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1.css
WC_eardir/Stores.war/storedir/css/base_rtl.css
This file is the RTL version of the WC_eardir/Stores.war/storedir/css/base.css file.
It is generated by a CSS mirroring script for globalization and is not manually maintained.
It is not linked by any JSP files.
It is imported by the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/styles_rtl.css
  • WC_eardir/Stores.war/storedir/css/common1_1_rtl.css
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1_rtl.css
WC_eardir/Stores.war/storedir/css/styles.css
This file is the stylesheet for responsive store pages.
It is linked by layout JSP files that use the env_vfileStylesheetrwd JSTL variable when no locale-specific versions of the file exist.
It does not contain CSS rules for sample marketing content.
It imports the following stylesheet:
  • WC_eardir/Stores.war/storedir/css/base.css
WC_eardir/Stores.war/storedir/css/styles_rtl.css
This file is the RTL version of the WC_eardir/Stores.war/storedir/css/styles.css file.
It is generated by a CSS mirroring script for globalization and is not manually maintained.
It is not linked by any JSP files.
It imports the following stylesheet:
  • WC_eardir/Stores.war/storedir/css/base_rtl.css
It is imported by the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/stylesar_EG.css
  • WC_eardir/Stores.war/storedir/css/stylesiw_IL.css
WC_eardir/Stores.war/storedir/css/styleslocale.css
Optional: This file is the locale-specific version of the WC_eardir/Stores.war/storedir/css/styles.css file.
It contains locale-specific patches to imported stylesheets.
It is linked by layout JSP files that use the env_vfileStylesheetrwd JSTL variable.
It imports the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/styles_rtl.css for the ar_EG and iw_IL locales.
  • WC_eardir/Stores.war/storedir/css/styles.css for all other locales.
WC_eardir/Stores.war/storedir/css/common1_1.css
This file is the stylesheet for desktop store pages that are not responsive.
It is linked by desktop pages that use the env_vfileStylesheet JSTL variable when no locale-specific versions of the file exist.
The desktop store page styles are updated to resemble the responsive store page styles.
It imports the following stylesheet, in addition to any existing imports contained in the file:
  • WC_eardir/Stores.war/storedir/css/base.css
WC_eardir/Stores.war/storedir/css/common1_1_rtl.css
This file is the RTL version of the WC_eardir/Stores.war/storedir/css/common1_1.css file.
It is generated by a CSS mirroring script for globalization and is not manually maintained.
It is not linked by any JSP files.
It is imported by the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/common1_1ar_EG.css
  • WC_eardir/Stores.war/storedir/css/common1_1iw_IL.css
WC_eardir/Stores.war/storedir/css/common1_1locale.css
Optional: This file is the locale-specific version of the WC_eardir/Stores.war/storedir/css/common1_1.css file.
It contains locale-specific patches to imported stylesheets.
It is linked by desktop store pages that are not responsive by using the env_vfileStylesheet JSTL variable.
It imports the following stylesheets:
  • WC_eardir/Stores.war/storedir/css/common1_1_rtl.css for the ar_EG and iw_IL locales.
  • WC_eardir/Stores.war/storedir/css/common1_1.css for all other locales.
WC_eardir/Stores.war/storedir/mobile30/css/common1_1.css
This file is the stylesheet for mobile store pages that are not responsive.
It is copied from the WC_eardir/Stores.war/storedir/mobile20/css/common1_1.css file.
It is linked by mobile pages that use the env_vfileStylesheet JSTL variable when no locale-specific versions of the file exist.
The mobile store page styles are updated to resemble the responsive store page styles.
It imports the following stylesheet, in addition to any existing imports contained in the file:
  • WC_eardir/Stores.war/storedir/css/base.css
WC_eardir/Stores.war/storedir/mobile30/css/common1_1_rtl.css
This file is the RTL version of the WC_eardir/Stores.war/storedir/mobile30/css/common1_1.css file.
It is generated by a CSS mirroring script for globalization and is not manually maintained.
It is not linked by any JSP files.
It imports the following stylesheet, in addition to any existing imports contained in the file:
  • WC_eardir/Stores.war/storedir/css/base_rtl.css
It is imported by the following stylesheets:
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1ar_EG.css
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1iw_IL.css
WC_eardir/Stores.war/storedir/mobile30/css/common1_1locale.css
Optional: This file is the locale-specific version of the WC_eardir/Stores.war/storedir/mobile30/css/common1_1.css file.
It contains locale-specific patches to imported stylesheets.
It is linked by mobile store pages that are not responsive by using the env_vfileStylesheet JSTL variable.
It imports the following stylesheets:
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1_rtl.css for the ar_EG and iw_IL locales.
  • WC_eardir/Stores.war/storedir/mobile30/css/common1_1.css for all other locales.

Marketing content

WC_eardir/Stores.war/storedir/rwdWebAssets/content_path
This directory contains the media assets for responsive marketing content.
WC_eardir/Stores.war/storedir/rwdWebAssets/content_path/styles.css
This file contains the stylesheet for responsive marketing content. It is linked by the marketing content's HTML text for LTR locales.
WC_eardir/Stores.war/storedir/rwdWebAssets/content_path/styles_rtl.css

This file is the RTL version of the WC_eardir/Stores.war/storedir/rwdWebAssets/content_path/styles.css file.

It is generated by a CSS mirroring script for globalization and is not manually maintained.

It is linked by the marketing content's HTML text for LTR locales.

Device-specific assets

WC_eardir/Stores.war/storedir/WorklightHybrid
This directory contains Worklight Hybrid application-specific files.

For more information, see Worklight Applications: WebSphere Commerce files.

WC_eardir/Stores.war/storedir/mobile30
This directory contains mobile-specific files.
These files contain the following characteristics and functions:
  • The assets were moved from the AuroraMobile.sar file. That is, the mobile-specific assets do not require a separate SAR file publish.
  • The top-level directory for mobile-specific assets is renamed from mobile20, to mobile30.