# ------------------------------------------------------------------------------ # ~/_data/pages/base.yml # Configuration data to specify the BASE (HTML) Layout of # ALL content pages # # Product/Info: # https://jekyll-one.com # # Copyright (C) 2019 Juergen Adams # # J1 Template is licensed under the MIT License. # See: https://github.com/jekyll-one/j1_template_mde/blob/master/LICENSE # ------------------------------------------------------------------------------ # NOTE: # By J1 template, "Liquid Procedures" are being used intensively. To load # HTML data for a layout, the loader procedure places the data based this # YAML data file into the REGION specified with a LANE. # ------------------------------------------------------------------------------ # ------------------------------------------------------------------------- # GLOBAL settings # # base # -------------------------------------------------------------------- # Defines a (canonical) base path. # # core (base) path for core components # asset (base) path for assets # # ------------------------------------------------------------------------- # Layout configuration settings # lanes|lane # -------------------------------------------------------------------- # Set LANE specific configuration parameters for a page LAYOUT. The # LANES array contains multiple (lane) hashes that describes the # type of the component that is placed into a lane and their specific # (placement) parameters. # # region # -------------------------------------------------------------------- # J1 Template defines, based on the general structure of a HTML # page (head and body), more specific regions to place HTML data # (lanes): # # head section. Contains (site-wide) meta # data (tags) and all CSS files to be loaded. # body-navigation section. Contains the navigation bar # (NavManager). Placed a the BEGINNING of the # body region . # body-banner section. Contains the page banner # (header). Placed AFTER the page navigation # but BEFORE the page content. # body-content section. J1 template puts a specific #
container element in the section # to place the content. All content specific # elements are loaded into the region 'body-content'. # Content may e.g. boxes, panels, quotes and # the page content. # body-footer section. J1 template puts a specific #
container element at the end of the # section. The body-footer region contains # all elements that should be loaded at the # end of a page - typically the page footer. # # values: head|body-navigation|body-banner| # body-content|body-footer # default: no defaults # # type # -------------------------------------------------------------------- # The (HTML) CONTENT of a lane can be placed for sychronous (sync) # or asychronous (async) load. If the content is placed synchronously, # a core component of J1 Template (base = core) or an HTML adapter # (base = module) generates the HTML code to be placed. # If the content is placed asynchronously, only a
element, using # an unique id, is placed for synchronous (page) load. The HTML code # will be generated asynchronously (by a module) after the page is # completely loaded (document-ready) and placed within the previously # generated
element (e.g. by a module). # # values: sync|async # default: no defaults # # base # -------------------------------------------------------------------- # Type SYNC only. The parameter base defines a (canonical) BASE # path. # # values: core|asset # default: no defaults # # path # -------------------------------------------------------------------- # Type SYNC only. The parameter path defines a PATH (relativ to BASE) # to the data source to be placed. # # values: string (path) # default: no defaults # # file # -------------------------------------------------------------------- # Type SYNC only. Defines the FILE to be placed (and # executed) for a lane. # # values: string # default: no defaults # # id # -------------------------------------------------------------------- # Type ASYNC only. Used for content placed asyncronously by (AJAX # calls) on an DIV element using this id. # the data on. # # values: string # default: no defaults # # class # -------------------------------------------------------------------- # Type ASYNC only. Additional CSS classes that are put on the # DIV element using this id. # # values: string (CSS class name) # default: no defaults # # ------------------------------------------------------------------------- # ------------------------------------------------------------------------- # GLOBAL configuration settings # # ------------------------------------------------------------------------- # Layout configuration settings # lanes: # ------------------------------------------------------------------ # META data loader (head) - lane: enabled: true region: head type: sync base: _includes/themes/j1 path: layouts file: layout_metadata_generator.html # ------------------------------------------------------------------ # Module RESOURCE loader (head) - lane: enabled: true region: head type: sync base: _includes/themes/j1 path: layouts file: layout_resource_generator.html # ------------------------------------------------------------------ # THEME loader (head region) - lane: enabled: true region: head type: sync base: _includes/themes/j1 path: layouts file: layout_theme_generator.html # ------------------------------------------------------------------ # NAV Module (body-navigation) # # NOTE: # The Generator of the NAV Module (generator.html) is based # on several Liquid procedures to generate the HTML code for # all components of the navigation system (NAV Module) as: # MainMenu, Quicklinks, SideBar and TopSearch. # - lane: enabled: true region: body-navigation type: sync base: _includes/themes/j1 path: modules/navigator file: generator.html # ------------------------------------------------------------------ # FOOTER (body-footer) # # NOTE: # The FOOTER component (default: footer_light_themes.html) is # a complex LOADER based on several Liquid procedures to LOAD # and INITIALIZE all parts of the page footer (cards) as: # About, News, Links and Contact. # - lane: enabled: true region: body-footer # type: sync # base: _includes/themes/j1 # path: modules/footers # file: footer_light_generator.html type: async id: j1_footer # ------------------------------------------------------------------ # Module SHIM loader (body-footer) # # NOTE: # - lane: enabled: true region: body-footer type: sync base: _includes/themes/j1 path: layouts file: layout_shim_generator.html # ------------------------------------------------------------------ # MODULE runner (body-footer) # # NOTE: # # - lane: enabled: true region: body-footer type: sync base: _includes/themes/j1 path: layouts file: layout_module_generator.html