Work with a Starter Template

You use a copy of a starter template provided by Oracle Content and Experience to create a new site, with a theme and custom components.

A starter template collects all the pieces you need to build a custom website in one package: the default site, layout, navigation, sample content, theme, associated content items, and so on. Different from other templates provided with Oracle Content and Experience, a starter template provides you with an easy-to-use basic framework for creating a new site, including a new theme.

Note:

A theme is usually shared between templates, but a starter template uses a copy of a theme.

The starter templates, StarterTemplate and JETStarterTemplate, are provided along with other templates in Oracle Content and Experience when your administrator enables templates during installation and configuration of the service. The Oracle JavaScript Extension Toolkit (JET) starter template includes the latest JET styling for templates, incorporates some page content (as JET components), and provides starter components for building JET-based templates and sites.

Basic Process

Here’s the basic process for working with a starter template:

  1. Create a new site and select the starter template. A new starter theme is created along with the new site.

    Note:

    Choose the site name carefully. The name you give the site is duplicated as the name of the new theme, and the theme will be visible to users once you publish the site. You can’t change the name of the theme after it is created.

    The starter site and theme contain a set of folders and files that are required to start site and theme development.

  2. Sync the new theme to your desktop. You can work on your desktop to extend and customize the theme with layouts and static assets. Because this is a copy of a theme and uses a name specific to your template, you can make changes to the theme without affecting the source theme.

  3. Open the site in Site Builder. You can use Site Builder to add to the site structure, add components and interactions to pages, and add content that will become part of the default site of the new template. You can reuse or remove the site content provided in the starter template.

  4. When the site and theme are ready, sync the changes with your Oracle Content and Experience instance, then create a new template from the selected site.

  5. Share the template so others can use it.

Create a Template Using a Starter Template

To use a starter template:

  1. In the Oracle Content and Experience side navigation, click Sites.

    A list of existing sites is displayed.

  2. Click Create.

  3. In the Create Site dialog, select the starter template to use as the basis for your site.

    The new site uses the theme provided with the starter template, renamed to match the new site name.

  4. In the dialog, enter a name for the site. This name is used in the site URL. You can use letters, numbers, underscores (_), and hyphens (-). If you enter a space, it's automatically replaced with an underscore.

    Don’t use the following names for templates, themes, components, sites, or site pages: authsite, content, pages, scstemplate_*, _comps, _components, _compsdelivery, _idcservice , _sitescloud, _sitesclouddelivery, _themes, _themesdelivery. Although you can use the following names for site pages, don’t use them for templates, themes, components, or sites: documents, sites.

    Note:

    The path for a Content and Experience site URL is case-sensitive. Case in the query or fragment strings is managed by developers in their custom code.

          https:[//host[:port]][/]path[?query][#fragment]
         \____________________/\________________________/
            Location          Data

  5. Optionally, enter a description for the site.

  6. When you’re ready, click Create.

    A progress bar shows the new site name and creation status. When the site is created, the name appears in the list of sites. Its initial status is offline.

    To quickly find your newly created site in the list, sort the list by Last Updated. The site you just created will appear at the top of the list.

    Note:

    You are automatically assigned the role of manager for the site you created.
  7. Use the desktop app to sync the theme to your desktop.

    You should now see the folder hierarchies and files for the theme.

  8. The starter theme contains a minimal set of folders and files, like these:

    theme
    	assets
    		css
    			main.css
    		js
    			topnav.js
    	designs
    		default
    			design.css
    			design.json
    			facebook.png 
    			googleplus.png 
    			linkedin.png 
    			twitter.png 
    			youtube.png 
    			x-close.png		
      layouts
    		index.html
    	resonsepages
    		404.html
    	_folder.json
    	_folder_icon.jpg
    	components.json
    	viewports.json

    The x-close.png file contains the default close icon for the cookie consent popup.

    The /layouts folder contains a starter page layout file (index.html) with the following contents:

    • A set of HTML tags that allow the file to be used as a page layout.

    • A single slot that has seeded text with instructions, such as how to sync the theme to your desktop, how to add a new page layout, how to add components to the page layout, and how to build site hierarchy using the new page layout.

    • A simple JavaScript navigation file that provides an example of how to use the renderer API JavaScript functions and objects. The rendered API is needed for traversing the site hierarchy and generating required HTML markup to allow navigation within the site.

    See also Basic Theme Structure.
  9. When you’re finished modifying the theme, sync the theme folders and files to your Oracle Content and Experience instance. To see how your changes to the theme look and behave in a site, open the site in Site Builder. This will likely be an iterative process.

  10. To view or modify the site, select the site and click Open in the right-click menu or click Open icon in the actions bar.

  11. Toggle the editor mode to Edit so you can make changes to the site. You can modify existing pages and add new pages using the page layout available in the starter themes.

    Note:

    If you are familiar with the page layout structure and usage, you can delete sections provided by the starter template that you don’t want and switch the layout on the sections that you do want to one of the new layouts.
  12. When you are finished making changes to the site, Save the site, then click Publish to merge the update to the base site.

  13. Select the site and create a template based on the site. This pulls in the assets and theme for the new template.

  14. Share the template with members you want to be able to use the template.