js.versionswitcher.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-doctools Show documentation
Neo4j Documentation Tools.
The newest version!
/**
 * Licensed to Neo Technology under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Neo Technology licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
jQuery( window ).load( function()
{
  var location = window.location;
  if ( location.hostname === 'neo4j.com' ) 
  {
    jQuery.getScript( location.protocol + '//neo4j.com/docs/meta/versions.js', function() {
      versionSwitcher( jQuery );    
    })
  }
} );

/**
 * Utility to browse different versions of the documentation. Requires the versions.js file loaded, which lists the
 * available (relevant) versions of the manual.
 */
function versionSwitcher( $ )
{
  var MAX_STABLE_COUNT = 2;
  var DOCS_BASE_URL = 'http://neo4j.com/docs/';

  var currentVersion = window.neo4jVersion;
  var currentPage = window.neo4jPageId + '.html';

  loadVersions();

  /**
   * Load an array of version into a div element and check if the current page actually exists in these versions.
   * Non-existing entries will be unlinked. Current version will be marked as such.
   */
  function loadVersions()
  {
    var $navHeader = $( '#navheader' );
    var $additionalVersions = $( '' );
    $.each( availableDocVersions, function( index, version )
    {
      if ( version === currentVersion )
      {
        return;
      }
      else
      {
        addVersion( version, $additionalVersions );
      }
    } );

    var $dropdown = $( 'Other versions ' );
    $dropdown.children().first().append( $additionalVersions );
    $navHeader.append( $dropdown );
  }

  function addVersion( version, $container )
  {
    var $optionWrapper = $( '' );
    var $newOption = $( '' + version + '' ).appendTo( $optionWrapper );
    var url = DOCS_BASE_URL + version + '/' + currentPage;
    $container.append( $optionWrapper );
    checkUrlExistence( url, function()
    {
      $newOption.attr( 'href', url );
      $newOption.attr( 'title', 'See this page in version ' + version + '.' );
    }, function()
    {
      $newOption.attr( 'title', 'This page does not exist in version ' + version + '.' );
      $optionWrapper.addClass( 'disabled' );
    } );
  }

  /**
   * Check if a specific URL exists. The success and failure functions will be automatically called on finish.
   */
  function checkUrlExistence( url, success, failure )
  {
    var settings = {
      'type' : 'HEAD',
      'async' : true,
      'url' : url
    };
    if ( success )
      settings.success = success;
    if ( failure )
      settings.error = failure;
    $.ajax( settings );
  }
}