The Responsive Aurora starter store files are organized in a defined structure by
default. The file structure contains layouts, containers, widgets, CSS style sheets, and marketing
content.
The following file structure exists when the Responsive Aurora
starter store is published:
Layouts and containers
- workspace_dir\crs-web\WebContent\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 style sheets.
- Includes page-level JavaScript files.
- Use the
<wcf:rest> tag to fetch data (page, page designs, e-Marketing spot)
from the HCL Commerce server.
- 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.
- CSS style sheet files are located at
crs-web\WebContent\storedir\css\styles.css or its RTL (read
as right-to-left) version for bidi languages.
- Contains optimizations for mobile devices.
- workspace_dir\crs-web\WebContent\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 style sheet or inline styles.
- Relies on the page-level style sheet workspace_dir\cre-web
\WebContent\storedir\css\styles.css file, or its RTL version, for the
fluid grid system.
Site-level widgets
The following files are included within the crs-web.war archive that is
within the
workspace_dir\crs-web\WebContent\storedir
directory. If you need to customize any of the site-level widgets or files, you must first extract
the archive and copy the required files to your own folder.
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\widgetdir\widget_identifier\widget_identifier_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 style sheet or inline styles.
- Relies on the page-level style sheet workspace_dir\cre-web
\WebContent\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.
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\widgetdir\Properties\widgettext.properties
- workspace_dir\crs-web\WebContent\widgetdir\Properties\widgettext_locale.properties
- These properties files contain the NL text for site-level widgets.
- This properties file contains the NL text for site-level widgets.
Store-level widgets
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\storedir\Widgets\widget_identifierwidget_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 style sheet or inline styles.
- Relies on the page-level style sheet workspace_dir\cre-web
\WebContent\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.
- workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\WEB-INF\classes\storedir/storetext_v2_locale.properties
- These properties files contain the NL text for store-level widgets.
CSS style sheets
- workspace_dir\crs-web\WebContent\storedir\css\base.css
- This file is the style sheet 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 style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\styles.css
- workspace_dir\crs-web\WebContent\storedir\css\common1_1.css
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1.css
- workspace_dir\crs-web\WebContent\storedir\css\base_rtl.css
- This file is the RTL version of the
workspace_dir\crs-web\WebContent\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 style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\styles_rtl.css
- workspace_dir\crs-web\WebContent\storedir\css\common1_1_rtl.css
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1_rtl.css
- workspace_dir\crs-web\WebContent\storedir\css\styles.css
- This file is the style sheet for responsive store pages.
- It is linked by layout JSP files that use the
env_vfilestyle sheetrwd 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 style sheet:
- workspace_dir\crs-web\WebContent\storedir\css\base.css
- workspace_dir\crs-web\WebContent\storedir\css\styles_rtl.css
- This file is the RTL version of the
workspace_dir\crs-web\WebContent\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 style sheet:
- workspace_dir\crs-web\WebContent\storedir\css\base_rtl.css
- It is imported by the following style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\stylesar_EG.css
- workspace_dir\crs-web\WebContent\storedir\css\stylesiw_IL.css
- workspace_dir\crs-web\WebContent\storedir\css\styleslocale.css
- Optional: This file is the locale-specific version of the
workspace_dir\crs-web\WebContent\storedir\css\styles.css
file.
- It contains locale-specific patches to imported style sheets.
- It is linked by layout JSP files that use the
env_vfilestyle sheetrwd JSTL
variable.
- It imports the following style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\styles_rtl.css
for the
ar_EG and iw_IL locales.
- workspace_dir\crs-web\WebContent\storedir\css\styles.css
for all other locales.
- workspace_dir\crs-web\WebContent\storedir\css\common1_1.css
- This file is the style sheet for desktop store pages that are not responsive.
- It is linked by desktop pages that use the
env_vfilestyle sheet 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 style sheet, in addition to any existing imports contained in the file:
- workspace_dir\crs-web\WebContent\storedir\css\base.css
- workspace_dir\crs-web\WebContent\storedir\css\common1_1_rtl.css
- This file is the RTL version of the
workspace_dir\crs-web\WebContent\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 style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\common1_1ar_EG.css
- workspace_dir\crs-web\WebContent\storedir\css\common1_1iw_IL.css
- workspace_dir\crs-web\WebContent\storedir\css\common1_1locale.css
- Optional: This file is the locale-specific version of the
workspace_dir\crs-web\WebContent\storedir\css\common1_1.css
file.
- It contains locale-specific patches to imported style sheets.
- It is linked by desktop store pages that are not responsive by using the
env_vfilestyle sheet JSTL variable.
- It imports the following style sheets:
- workspace_dir\crs-web\WebContent\storedir\css\common1_1_rtl.css
for the
ar_EG and iw_IL locales.
- workspace_dir\crs-web\WebContent\storedir\css\common1_1.css
for all other locales.
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1.css
- This file is the style sheet for mobile store pages that are not
responsive.
- It is copied from the
workspace_dir\crs-web\WebContent\storedir\css\common1_1.css
file.
- It is linked by mobile pages that use the
env_vfilestyle sheet 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 style sheet, in addition to any existing imports contained in the file:
- workspace_dir\crs-web\WebContent\storedir\css\base.css
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1_rtl.css
- This file is the RTL version of the
workspace_dir\crs-web\WebContent\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 style sheet, in addition to any existing imports contained in the file:
- workspace_dir\crs-web\WebContent\storedir\css\base_rtl.css
- It is imported by the following style sheets:
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1ar_EG.css
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1iw_IL.css
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1locale.css
- Optional: This file is the locale-specific version of the
workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1.css
file.
- It contains locale-specific patches to imported style sheets.
- It is linked by mobile store pages that are not responsive by using the
env_vfilestyle sheet JSTL variable.
- It imports the following style sheets:
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1_rtl.css
for the
ar_EG and iw_IL locales.
- workspace_dir\crs-web\WebContent\storedir\mobile30\css\common1_1.css
for all other locales.
Marketing content
- workspace_dir\crs-web\WebContent\storedir\rwdWebAssets\content_path
- This directory contains the media assets for responsive marketing
content.
- workspace_dir\crs-web\WebContent\storedir\rwdWebAssets\content_path\styles.css
- This file contains the style sheet for responsive marketing content.
It is linked by the marketing content's HTML text for LTR locales.
- workspace_dir\crs-web\WebContent\storedir\css\styles_rtl.css
-
This file is the RTL version of the
workspace_dir\crs-web\WebContent\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.
- workspace_dir\crs-web\WebContent\storedir\mobile30
- This directory contains mobile-specific assets.