class JekyllOpenSdgPlugins::CreatePages

Public Instance Methods

generate(site) click to toggle source
# File lib/jekyll-open-sdg-plugins/create_pages.rb, line 9
def generate(site)
  # If site.create_pages is set, create the 4 required pages. These include:
  # - the home page: /
  # - the indicators json page: /indicators.json
  # - the search results page: /search
  # - the reporting status page: /reporting-status
  #
  # These can be overridden though, with a create_pages.pages setting in
  # _config.yml, like so:
  #
  # create_pages:
  #   pages:
  #     - folder: ''
  #       layout: frontpage
  #     - filename: my-json-file.json
  #       folder: my-subfolder
  #       layout: indicator-json
  #
  # Note the optional "filename" setting for when the page needs a specific
  # filename (as opposed to being "index.html" inside a named folder).
  #
  # To use the default 4 pages, simply put:
  #
  # create_pages: true
  if (site.config['languages'] and site.config['create_pages'])

    default_pages = [
      {
        'folder' => '/',
        'layout' => 'frontpage'
      },
      {
        'folder' => '/reporting-status',
        'layout' => 'reportingstatus',
        'title' => 'status.reporting_status',
      },
      {
        'filename' => 'indicators.json',
        'folder' => '/',
        'layout' => 'indicator-json',
      },
      {
        'folder' => '/search',
        'layout' => 'search',
        'title' => 'search.search',
      }
    ]
    pages = default_pages
    if (site.config['create_pages'].is_a?(Hash) and site.config['create_pages'].key?('pages'))
      # Backwards compatability to support the deprecated "pages" key.
      pages = site.config['create_pages']['pages']
    elsif site.config['create_pages'].is_a?(Array)
      pages = site.config['create_pages']
    end

    # Clone pages so that we don't edit the original.
    pages = pages.clone

    # Hardcode the site configuration page if it's not already there.
    form_settings = site.config['site_config_form']
    config_page = pages.find { |page| page['layout'] == 'config-builder' }
    if config_page == nil
      if form_settings && form_settings['enabled']
        pages.push({
          'folder' => '/config',
          'layout' => 'config-builder',
          'title' => 'Open SDG site configuration',
          'config_type' => 'site',
          'config_filename' => 'site_config.yml',
        })
      end
    end
    # Make sure the form settings are set.
    config_page = pages.find { |page| page['layout'] == 'config-builder' }
    if config_page != nil && form_settings && form_settings['enabled']
      # Special treatment of repository_link.
      if form_settings['repository_link'] && form_settings['repository_link'] != ''
        unless form_settings['repository_link'].start_with?('http')
          repo_url = site.config['repository_url_site']
          if repo_url && repo_url != '' && repo_url.start_with?('http')
            form_settings['repository_link'] = repo_url + form_settings['repository_link']
          end
        end
      end
      config_page['form_settings'] = form_settings
    end

    # See if we need to "map" any language codes.
    languages_public = Hash.new
    if site.config['languages_public']
      languages_public = opensdg_languages_public(site)
    end

    # Loop through the languages.
    site.config['languages'].each_with_index do |language, index|
      # Get the "public language" (for URLs) which may be different.
      language_public = language
      if languages_public[language]
        language_public = languages_public[language]
      end
      # Loop through the pages.
      pages.each do |page|
        # Add the language subfolder for all except the default (first) language.
        dir = index == 0 ? page['folder'] : File.join(language_public, page['folder'])
        # Create the page.
        site.collections['pages'].docs << OpenSdgPage.new(site, site.source, dir, page, language)
      end
    end
  end
end