Update the documentation pages

This commit is contained in:
OpenIddict Bot
2017-09-25 15:15:04 +00:00
parent 28d8281232
commit f163cae6a1
24 changed files with 7252 additions and 18 deletions

895
styles/docfx.css Normal file
View File

@@ -0,0 +1,895 @@
/* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License.txt in the project root for license information. */
html,
body {
font-family: 'Segoe UI', Tahoma, Helvetica, sans-serif;
height: 100%;
}
button,
a {
color: #337ab7;
cursor: pointer;
}
button:hover,
button:focus,
a:hover,
a:focus {
color: #23527c;
text-decoration: none;
}
a.disable,
a.disable:hover {
text-decoration: none;
cursor: default;
color: #000000;
}
/* workaround for leave space for fixed navbar with # anchor url*/
h1:before,
h2:before,
h3:before,
h4:before {
content: '';
display: block;
position: relative;
width: 0;
height: 100px;
margin-top: -100px;
}
h1, h2, h3, h4, h5, h6, .text-break {
word-wrap: break-word;
word-break: break-word;
}
h1 mark,
h2 mark,
h3 mark,
h4 mark,
h5 mark,
h6 mark {
padding: 0;
}
.inheritance .level0:before,
.inheritance .level1:before,
.inheritance .level2:before,
.inheritance .level3:before,
.inheritance .level4:before,
.inheritance .level5:before {
content: '↳';
margin-right: 5px;
}
.inheritance .level0 {
margin-left: 0em;
}
.inheritance .level1 {
margin-left: 1em;
}
.inheritance .level2 {
margin-left: 2em;
}
.inheritance .level3 {
margin-left: 3em;
}
.inheritance .level4 {
margin-left: 4em;
}
.inheritance .level5 {
margin-left: 5em;
}
span.parametername,
span.paramref,
span.typeparamref {
font-style: italic;
}
span.languagekeyword{
font-weight: bold;
}
svg:hover path {
fill: #ffffff;
}
.hljs {
display: inline;
background-color: inherit;
padding: 0;
}
/* additional spacing fixes */
.btn + .btn {
margin-left: 10px;
}
.btn.pull-right {
margin-left: 10px;
margin-top: 5px;
}
.table {
margin-bottom: 10px;
}
table p {
margin-bottom: 0;
}
table a {
display: inline-block;
}
h1,
.h1,
h2,
.h2,
h3,
.h3 {
margin-top: 15px;
margin-bottom: 10px;
font-weight: 400;
}
h4,
.h4,
h5,
.h5,
h6,
.h6 {
margin-top: 10px;
margin-bottom: 5px;
}
.navbar {
margin-bottom: 0;
}
#wrapper {
min-height: 100%;
position: relative;
}
/* blends header footer and content together with gradient effect */
.grad-top {
/* For Safari 5.1 to 6.0 */
/* For Opera 11.1 to 12.0 */
/* For Firefox 3.6 to 15 */
background: linear-gradient(rgba(0, 0, 0, 0.05), rgba(0, 0, 0, 0));
/* Standard syntax */
height: 5px;
}
.grad-bottom {
/* For Safari 5.1 to 6.0 */
/* For Opera 11.1 to 12.0 */
/* For Firefox 3.6 to 15 */
background: linear-gradient(rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.05));
/* Standard syntax */
height: 5px;
}
.divider {
margin: 0 5px;
color: #cccccc;
}
hr {
border-color: #cccccc;
}
header {
position: fixed;
top: 0;
left: 0;
right: 0;
z-index: 1000;
}
header .navbar {
border-width: 0 0 1px;
border-radius: 0;
}
.navbar-brand {
font-size: inherit;
padding: 0;
}
.navbar-collapse {
margin: 0 -15px;
}
.subnav {
min-height: 40px;
}
.inheritance h5, .inheritedMembers h5{
padding-bottom: 5px;
border-bottom: 1px solid #ccc;
}
article h1, article h2, article h3, article h4{
margin-top: 25px;
}
article h4{
border-bottom: 1px solid #ccc;
}
article span.small.pull-right{
margin-top: 20px;
}
article section {
margin-left: 1em;
}
/*.expand-all {
padding: 10px 0;
}*/
.breadcrumb {
margin: 0;
padding: 10px 0;
background-color: inherit;
white-space: nowrap;
}
.breadcrumb > li + li:before {
content: "\00a0/";
}
#autocollapse.collapsed .navbar-header {
float: none;
}
#autocollapse.collapsed .navbar-toggle {
display: block;
}
#autocollapse.collapsed .navbar-collapse {
border-top: 1px solid transparent;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1);
}
#autocollapse.collapsed .navbar-collapse.collapse {
display: none !important;
}
#autocollapse.collapsed .navbar-nav {
float: none !important;
margin: 7.5px -15px;
}
#autocollapse.collapsed .navbar-nav > li {
float: none;
}
#autocollapse.collapsed .navbar-nav > li > a {
padding-top: 10px;
padding-bottom: 10px;
}
#autocollapse.collapsed .collapse.in,
#autocollapse.collapsed .collapsing {
display: block !important;
}
#autocollapse.collapsed .collapse.in .navbar-right,
#autocollapse.collapsed .collapsing .navbar-right {
float: none !important;
}
#autocollapse .form-group {
width: 100%;
}
#autocollapse .form-control {
width: 100%;
}
#autocollapse .navbar-header {
margin-left: 0;
margin-right: 0;
}
#autocollapse .navbar-brand {
margin-left: 0;
}
.collapse.in,
.collapsing {
text-align: center;
}
.collapsing .navbar-form {
margin: 0 auto;
max-width: 400px;
padding: 10px 15px;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1);
}
.collapsed .collapse.in .navbar-form {
margin: 0 auto;
max-width: 400px;
padding: 10px 15px;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1);
}
.navbar .navbar-nav {
display: inline-block;
}
.docs-search {
background: white;
vertical-align: middle;
}
.docs-search > .search-query {
font-size: 14px;
border: 0;
width: 120%;
color: #555;
}
.docs-search > .search-query:focus {
outline: 0;
}
.search-results-frame {
clear: both;
display: table;
width: 100%;
}
.search-results.ng-hide {
display: none;
}
.search-results-container {
padding-bottom: 1em;
border-top: 1px solid #111;
background: rgba(25, 25, 25, 0.5);
}
.search-results-container .search-results-group {
padding-top: 50px !important;
padding: 10px;
}
.search-results-group-heading {
font-family: "Open Sans";
padding-left: 10px;
color: white;
}
.search-close {
position: absolute;
left: 50%;
margin-left: -100px;
color: white;
text-align: center;
padding: 5px;
background: #333;
border-top-right-radius: 5px;
border-top-left-radius: 5px;
width: 200px;
box-shadow: 0 0 10px #111;
}
#search {
display: none;
}
/* Search results display*/
#search-results {
max-width: 960px !important;
margin-top: 120px;
margin-bottom: 115px;
margin-left: auto;
margin-right: auto;
line-height: 1.8;
display: none;
}
#search-results>.search-list {
text-align: center;
font-size: 2.5rem;
margin-bottom: 50px;
}
#search-results p {
text-align: center;
}
#search-results .sr-items {
font-size: 24px;
}
.sr-item {
margin-bottom: 25px;
}
.sr-item>.item-href {
font-size: 14px;
color: #093;
}
.sr-item>.item-brief {
font-size: 13px;
}
.pagination>li>a {
color: #47A7A0
}
.pagination>.active>a {
background-color: #47A7A0;
border-color: #47A7A0;
}
.fixed_header {
position: fixed;
width: 100%;
padding-bottom: 10px;
padding-top: 10px;
margin: 0px;
top: 0;
z-index: 9999;
left: 0;
}
.fixed_header+.toc{
margin-top: 50px;
margin-left: 0;
}
.sidenav, .fixed_header, .toc {
background-color: #f1f1f1;
}
.sidetoc {
position: fixed;
width: 260px;
top: 150px;
bottom: 0;
overflow-x: hidden;
overflow-y: auto;
background-color: #f1f1f1;
border-left: 1px solid #e7e7e7;
border-right: 1px solid #e7e7e7;
z-index: 1;
}
.sidetoc.shiftup {
bottom: 70px;
}
body .toc{
background-color: #f1f1f1;
overflow-x: hidden;
}
.sidetoggle.ng-hide {
display: block !important;
}
.sidetoc-expand > .caret {
margin-left: 0px;
margin-top: -2px;
}
.sidetoc-expand > .caret-side {
border-left: 4px solid;
border-top: 4px solid transparent;
border-bottom: 4px solid transparent;
margin-left: 4px;
margin-top: -4px;
}
.sidetoc-heading {
font-weight: 500;
}
.toc {
margin: 0px 0 0 10px;
padding: 0 10px;
}
.expand-stub {
position: absolute;
left: -10px;
}
.toc .nav > li > a.sidetoc-expand {
position: absolute;
top: 0;
left: 0;
}
.toc .nav > li > a {
color: #666666;
margin-left: 5px;
display: block;
padding: 0;
}
.toc .nav > li > a:hover,
.toc .nav > li > a:focus {
color: #000000;
background: none;
text-decoration: inherit;
}
.toc .nav > li.active > a {
color: #337ab7;
}
.toc .nav > li.active > a:hover,
.toc .nav > li.active > a:focus {
color: #23527c;
}
.toc .nav > li> .expand-stub {
cursor: pointer;
}
.toc .nav > li.active > .expand-stub::before,
.toc .nav > li.in > .expand-stub::before,
.toc .nav > li.in.active > .expand-stub::before,
.toc .nav > li.filtered > .expand-stub::before {
content: "-";
}
.toc .nav > li > .expand-stub::before,
.toc .nav > li.active > .expand-stub::before {
content: "+";
}
.toc .nav > li.filtered > ul,
.toc .nav > li.in > ul {
display: block;
}
.toc .nav > li > ul {
display: none;
}
.toc ul{
font-size: 12px;
margin: 0 0 0 3px;
}
.toc .level1 > li {
font-weight: bold;
margin-top: 10px;
position: relative;
font-size: 16px;
}
.toc .level2 {
font-weight: normal;
margin: 5px 0 0 15px;
font-size: 14px;
}
.toc-toggle {
display: none;
margin: 0 15px 0px 15px;
}
.sidefilter {
position: fixed;
top: 90px;
width: 260px;
background-color: #f1f1f1;
padding: 15px;
border-left: 1px solid #e7e7e7;
border-right: 1px solid #e7e7e7;
z-index: 1;
}
.toc-filter {
border-radius: 5px;
background: #fff;
color: #666666;
padding: 5px;
position: relative;
margin: 0 5px 0 5px;
}
.toc-filter > input {
border: 0;
color: #666666;
padding-left: 20px;
width: 100%;
}
.toc-filter > input:focus {
outline: 0;
}
.toc-filter > .filter-icon {
position: absolute;
top: 10px;
left: 5px;
}
.article {
margin-top: 120px;
margin-bottom: 115px;
}
#_content>a{
margin-top: 105px;
}
.article.grid-right {
margin-left: 280px;
}
.inheritance hr {
margin-top: 5px;
margin-bottom: 5px;
}
.article img {
max-width: 100%;
}
.sideaffix {
margin-top: 50px;
font-size: 12px;
max-height: 100%;
overflow: hidden;
top: 100px;
bottom: 10px;
position: fixed;
}
.sideaffix.shiftup {
bottom: 70px;
}
.affix {
position: relative;
height: 100%;
}
.sideaffix > div.contribution {
margin-bottom: 20px;
}
.sideaffix > div.contribution > ul > li > a.contribution-link {
padding: 6px 10px;
font-weight: bold;
font-size: 14px;
}
.sideaffix > div.contribution > ul > li > a.contribution-link:hover {
background-color: #ffffff;
}
.sideaffix ul.nav > li > a:focus {
background: none;
}
.affix h5 {
font-weight: bold;
text-transform: uppercase;
padding-left: 10px;
font-size: 12px;
}
.affix > ul.level1 {
overflow: hidden;
padding-bottom: 10px;
height: calc(100% - 100px);
margin-right: -20px;
}
.affix ul > li > a:before {
color: #cccccc;
position: absolute;
}
.affix ul > li > a:hover {
background: none;
color: #666666;
}
.affix ul > li.active > a,
.affix ul > li.active > a:before {
color: #337ab7;
}
.affix ul > li > a {
padding: 5px 12px;
color: #666666;
}
.affix > ul > li.active:last-child {
margin-bottom: 50px;
}
.affix > ul > li > a:before {
content: "|";
font-size: 16px;
top: 1px;
left: 0;
}
.affix > ul > li.active > a,
.affix > ul > li.active > a:before {
color: #337ab7;
font-weight: bold;
}
.affix ul ul > li > a {
padding: 2px 15px;
}
.affix ul ul > li > a:before {
content: ">";
font-size: 14px;
top: -1px;
left: 5px;
}
.affix ul > li > a:before,
.affix ul ul {
display: none;
}
.affix ul > li.active > ul,
.affix ul > li.active > a:before,
.affix ul > li > a:hover:before {
display: block;
white-space: nowrap;
}
.codewrapper {
position: relative;
}
.trydiv {
height: 0px;
}
.tryspan {
position: absolute;
top: 0px;
right: 0px;
border-style: solid;
border-radius: 0px 4px;
box-sizing: border-box;
border-width: 1px;
border-color: #cccccc;
text-align: center;
padding: 2px 8px;
background-color: white;
font-size: 12px;
cursor: pointer;
z-index: 100;
display: none;
color: #767676;
}
.tryspan:hover {
background-color: #3b8bd0;
color: white;
border-color: #3b8bd0;
}
.codewrapper:hover .tryspan {
display: block;
}
.sample-response .response-content{
max-height: 200px;
}
footer {
position: absolute;
left: 0;
right: 0;
bottom: 0;
z-index: 1000;
}
.footer {
border-top: 1px solid #e7e7e7;
background-color: #f8f8f8;
padding: 15px 0;
}
@media (min-width: 768px) {
#sidetoggle.collapse {
display: block;
}
.topnav .navbar-nav {
float: none;
white-space: nowrap;
}
.topnav .navbar-nav > li {
float: none;
display: inline-block;
}
}
@media only screen and (max-width: 768px) {
#mobile-indicator {
display: block;
}
/* TOC display for responsive */
.article {
margin-top: 30px !important;
}
header {
position: static;
}
.topnav {
text-align: center;
}
.sidenav {
padding: 15px 0;
margin-left: -15px;
margin-right: -15px;
}
.sidefilter {
position: static;
width: auto;
float: none;
border: none;
}
.sidetoc {
position: static;
width: auto;
float: none;
padding-bottom: 0px;
border: none;
}
.toc .nav > li, .toc .nav > li >a {
display: inline-block;
}
.toc li:after {
margin-left: -3px;
margin-right: 5px;
content: ", ";
color: #666666;
}
.toc .level1 > li {
display: block;
}
.toc .level1 > li:after {
display: none;
}
.article.grid-right {
margin-left: 0;
}
.grad-top,
.grad-bottom {
display: none;
}
.toc-toggle {
display: block;
}
.sidetoggle.ng-hide {
display: none !important;
}
/*.expand-all {
display: none;
}*/
.sideaffix {
display: none;
}
.mobile-hide {
display: none;
}
.breadcrumb {
white-space: inherit;
}
/* workaround for #hashtag url is no longer needed*/
h1:before,
h2:before,
h3:before,
h4:before {
content: '';
display: none;
}
}
/* For toc iframe */
@media (max-width: 260px) {
.toc .level2 > li {
display: block;
}
.toc .level2 > li:after {
display: none;
}
}
/* For code snippet line highlight */
pre > code .line-highlight {
background-color: #ffffcc;
}
/* Alerts */
.alert h5 {
text-transform: uppercase;
font-weight: bold;
margin-top: 0;
}
.alert h5:before {
position:relative;
top:1px;
display:inline-block;
font-family:'Glyphicons Halflings';
line-height:1;
-webkit-font-smoothing:antialiased;
-moz-osx-font-smoothing:grayscale;
margin-right: 5px;
font-weight: normal;
}
.alert-info h5:before {
content:"\e086"
}
.alert-warning h5:before {
content:"\e127"
}
.alert-danger h5:before {
content:"\e107"
}
/* For Embedded Video */
div.embeddedvideo {
padding-top: 56.25%;
position: relative;
width: 100%;
}
div.embeddedvideo iframe {
position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
width: 100%;
height: 100%;
}
/* For printer */
@media print{
.article.grid-right {
margin-top: 0px;
margin-left: 0px;
}
.sideaffix {
display: none;
}
.mobile-hide {
display: none;
}
.footer {
display: none;
}
}

784
styles/docfx.js Normal file
View File

@@ -0,0 +1,784 @@
// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
$(function () {
var active = 'active';
var expanded = 'in';
var collapsed = 'collapsed';
var filtered = 'filtered';
var show = 'show';
var hide = 'hide';
var util = new utility();
highlight();
enableSearch();
renderTables();
renderAlerts();
renderLinks();
renderNavbar();
renderSidebar();
renderAffix();
renderFooter();
renderLogo();
breakText();
window.refresh = function (article) {
// Update markup result
if (typeof article == 'undefined' || typeof article.content == 'undefined')
console.error("Null Argument");
$("article.content").html(article.content);
highlight();
renderTables();
renderAlerts();
renderAffix();
}
function breakText() {
$(".xref").addClass("text-break");
var texts = $(".text-break");
texts.each(function () {
$(this).text(function (index, text) {
return util.breakText(text);
})
});
}
// Styling for tables in conceptual documents using Bootstrap.
// See http://getbootstrap.com/css/#tables
function renderTables() {
$('table').addClass('table table-bordered table-striped table-condensed');
}
// Styling for alerts.
function renderAlerts() {
$('.NOTE, .TIP').addClass('alert alert-info');
$('.WARNING').addClass('alert alert-warning');
$('.IMPORTANT, .CAUTION').addClass('alert alert-danger');
}
// Enable anchors for headings.
(function () {
anchors.options = {
placement: 'left',
visible: 'touch'
};
anchors.add('article h2:not(.no-anchor), article h3:not(.no-anchor), article h4:not(.no-anchor)');
})();
// Open links to different host in a new window.
function renderLinks() {
if ($("meta[property='docfx:newtab']").attr("content") === "true") {
$(document.links).filter(function () {
return this.hostname !== window.location.hostname;
}).attr('target', '_blank');
}
}
// Enable highlight.js
function highlight() {
$('pre code').each(function (i, block) {
hljs.highlightBlock(block);
});
$('pre code[highlight-lines]').each(function (i, block) {
if (block.innerHTML === "") return;
var lines = block.innerHTML.split('\n');
queryString = block.getAttribute('highlight-lines');
if (!queryString) return;
var ranges = queryString.split(',');
for (var j = 0, range; range = ranges[j++];) {
var found = range.match(/^(\d+)\-(\d+)?$/);
if (found) {
// consider region as `{startlinenumber}-{endlinenumber}`, in which {endlinenumber} is optional
var start = +found[1];
var end = +found[2];
if (isNaN(end) || end > lines.length) {
end = lines.length;
}
} else {
// consider region as a sigine line number
if (isNaN(range)) continue;
var start = +range;
var end = start;
}
if (start <= 0 || end <= 0 || start > end || start > lines.length) {
// skip current region if invalid
continue;
}
lines[start - 1] = '<span class="line-highlight">' + lines[start - 1];
lines[end - 1] = lines[end - 1] + '</span>';
}
block.innerHTML = lines.join('\n');
});
}
// Support full-text-search
function enableSearch() {
var query;
var relHref = $("meta[property='docfx\\:rel']").attr("content");
if (typeof relHref === 'undefined') {
return;
}
try {
var worker = new Worker(relHref + 'styles/search-worker.js');
if (!worker && !window.worker) {
localSearch();
} else {
webWorkerSearch();
}
renderSearchBox();
highlightKeywords();
addSearchEvent();
} catch (e) {
console.error(e);
}
//Adjust the position of search box in navbar
function renderSearchBox() {
autoCollapse();
$(window).on('resize', autoCollapse);
$(document).on('click', '.navbar-collapse.in', function (e) {
if ($(e.target).is('a')) {
$(this).collapse('hide');
}
});
function autoCollapse() {
var navbar = $('#autocollapse');
if (navbar.height() === null) {
setTimeout(autoCollapse, 300);
}
navbar.removeClass(collapsed);
if (navbar.height() > 60) {
navbar.addClass(collapsed);
}
}
}
// Search factory
function localSearch() {
console.log("using local search");
var lunrIndex = lunr(function () {
this.ref('href');
this.field('title', { boost: 50 });
this.field('keywords', { boost: 20 });
});
lunr.tokenizer.seperator = /[\s\-\.]+/;
var searchData = {};
var searchDataRequest = new XMLHttpRequest();
var indexPath = relHref + "index.json";
if (indexPath) {
searchDataRequest.open('GET', indexPath);
searchDataRequest.onload = function () {
if (this.status != 200) {
return;
}
searchData = JSON.parse(this.responseText);
for (var prop in searchData) {
if (searchData.hasOwnProperty(prop)){
lunrIndex.add(searchData[prop]);
}
}
}
searchDataRequest.send();
}
$("body").bind("queryReady", function () {
var hits = lunrIndex.search(query);
var results = [];
hits.forEach(function (hit) {
var item = searchData[hit.ref];
results.push({ 'href': item.href, 'title': item.title, 'keywords': item.keywords });
});
handleSearchResults(results);
});
}
function webWorkerSearch() {
console.log("using Web Worker");
var indexReady = $.Deferred();
worker.onmessage = function (oEvent) {
switch (oEvent.data.e) {
case 'index-ready':
indexReady.resolve();
break;
case 'query-ready':
var hits = oEvent.data.d;
handleSearchResults(hits);
break;
}
}
indexReady.promise().done(function () {
$("body").bind("queryReady", function () {
worker.postMessage({ q: query });
});
});
}
// Highlight the searching keywords
function highlightKeywords() {
var q = url('?q');
if (q !== null) {
var keywords = q.split("%20");
keywords.forEach(function (keyword) {
if (keyword !== "") {
$('.data-searchable *').mark(keyword);
$('article *').mark(keyword);
}
});
}
}
function addSearchEvent() {
$('body').bind("searchEvent", function () {
$('#search-query').keypress(function (e) {
return e.which !== 13;
});
$('#search-query').keyup(function () {
query = $(this).val();
if (query.length < 3) {
flipContents("show");
} else {
flipContents("hide");
$("body").trigger("queryReady");
$('#search-results>.search-list').text('Search Results for "' + query + '"');
}
}).off("keydown");
});
}
function flipContents(action) {
if (action === "show") {
$('.hide-when-search').show();
$('#search-results').hide();
} else {
$('.hide-when-search').hide();
$('#search-results').show();
}
}
function relativeUrlToAbsoluteUrl(currentUrl, relativeUrl) {
var currentItems = currentUrl.split(/\/+/);
var relativeItems = relativeUrl.split(/\/+/);
var depth = currentItems.length - 1;
var items = [];
for (var i = 0; i < relativeItems.length; i++) {
if (relativeItems[i] === '..') {
depth--;
} else if (relativeItems[i] !== '.') {
items.push(relativeItems[i]);
}
}
return currentItems.slice(0, depth).concat(items).join('/');
}
function extractContentBrief(content) {
var briefOffset = 512;
var words = query.split(/\s+/g);
var queryIndex = content.indexOf(words[0]);
var briefContent;
if (queryIndex > briefOffset) {
return "..." + content.slice(queryIndex - briefOffset, queryIndex + briefOffset) + "...";
} else if (queryIndex <= briefOffset) {
return content.slice(0, queryIndex + briefOffset) + "...";
}
}
function handleSearchResults(hits) {
var numPerPage = 10;
$('#pagination').empty();
$('#pagination').removeData("twbs-pagination");
if (hits.length === 0) {
$('#search-results>.sr-items').html('<p>No results found</p>');
} else {
$('#pagination').twbsPagination({
totalPages: Math.ceil(hits.length / numPerPage),
visiblePages: 5,
onPageClick: function (event, page) {
var start = (page - 1) * numPerPage;
var curHits = hits.slice(start, start + numPerPage);
$('#search-results>.sr-items').empty().append(
curHits.map(function (hit) {
var currentUrl = window.location.href;
var itemRawHref = relativeUrlToAbsoluteUrl(currentUrl, relHref + hit.href);
var itemHref = relHref + hit.href + "?q=" + query;
var itemTitle = hit.title;
var itemBrief = extractContentBrief(hit.keywords);
var itemNode = $('<div>').attr('class', 'sr-item');
var itemTitleNode = $('<div>').attr('class', 'item-title').append($('<a>').attr('href', itemHref).attr("target", "_blank").text(itemTitle));
var itemHrefNode = $('<div>').attr('class', 'item-href').text(itemRawHref);
var itemBriefNode = $('<div>').attr('class', 'item-brief').text(itemBrief);
itemNode.append(itemTitleNode).append(itemHrefNode).append(itemBriefNode);
return itemNode;
})
);
query.split(/\s+/).forEach(function (word) {
if (word !== '') {
$('#search-results>.sr-items *').mark(word);
}
});
}
});
}
}
};
// Update href in navbar
function renderNavbar() {
var navbar = $('#navbar ul')[0];
if (typeof (navbar) === 'undefined') {
loadNavbar();
} else {
$('#navbar ul a.active').parents('li').addClass(active);
renderBreadcrumb();
}
function loadNavbar() {
var navbarPath = $("meta[property='docfx\\:navrel']").attr("content");
if (!navbarPath) {
return;
}
navbarPath = navbarPath.replace(/\\/g, '/');
var tocPath = $("meta[property='docfx\\:tocrel']").attr("content") || '';
if (tocPath) tocPath = tocPath.replace(/\\/g, '/');
$.get(navbarPath, function (data) {
$(data).find("#toc>ul").appendTo("#navbar");
if ($('#search-results').length !== 0) {
$('#search').show();
$('body').trigger("searchEvent");
}
var index = navbarPath.lastIndexOf('/');
var navrel = '';
if (index > -1) {
navrel = navbarPath.substr(0, index + 1);
}
$('#navbar>ul').addClass('navbar-nav');
var currentAbsPath = util.getAbsolutePath(window.location.pathname);
// set active item
$('#navbar').find('a[href]').each(function (i, e) {
var href = $(e).attr("href");
if (util.isRelativePath(href)) {
href = navrel + href;
$(e).attr("href", href);
// TODO: currently only support one level navbar
var isActive = false;
var originalHref = e.name;
if (originalHref) {
originalHref = navrel + originalHref;
if (util.getDirectory(util.getAbsolutePath(originalHref)) === util.getDirectory(util.getAbsolutePath(tocPath))) {
isActive = true;
}
} else {
if (util.getAbsolutePath(href) === currentAbsPath) {
isActive = true;
}
}
if (isActive) {
$(e).addClass(active);
}
}
});
renderNavbar();
});
}
}
function renderSidebar() {
var sidetoc = $('#sidetoggle .sidetoc')[0];
if (typeof (sidetoc) === 'undefined') {
loadToc();
} else {
registerTocEvents();
if ($('footer').is(':visible')) {
$('.sidetoc').addClass('shiftup');
}
// Scroll to active item
var top = 0;
$('#toc a.active').parents('li').each(function (i, e) {
$(e).addClass(active).addClass(expanded);
$(e).children('a').addClass(active);
top += $(e).position().top;
})
$('.sidetoc').scrollTop(top - 50);
if ($('footer').is(':visible')) {
$('.sidetoc').addClass('shiftup');
}
renderBreadcrumb();
}
function registerTocEvents() {
$('.toc .nav > li > .expand-stub').click(function (e) {
$(e.target).parent().toggleClass(expanded);
});
$('.toc .nav > li > .expand-stub + a:not([href])').click(function (e) {
$(e.target).parent().toggleClass(expanded);
});
$('#toc_filter_input').on('input', function (e) {
var val = this.value;
if (val === '') {
// Clear 'filtered' class
$('#toc li').removeClass(filtered).removeClass(hide);
return;
}
// Get leaf nodes
$('#toc li>a').filter(function (i, e) {
return $(e).siblings().length === 0
}).each(function (i, anchor) {
var text = $(anchor).attr('title');
var parent = $(anchor).parent();
var parentNodes = parent.parents('ul>li');
for (var i = 0; i < parentNodes.length; i++) {
var parentText = $(parentNodes[i]).children('a').attr('title');
if (parentText) text = parentText + '.' + text;
};
if (filterNavItem(text, val)) {
parent.addClass(show);
parent.removeClass(hide);
} else {
parent.addClass(hide);
parent.removeClass(show);
}
});
$('#toc li>a').filter(function (i, e) {
return $(e).siblings().length > 0
}).each(function (i, anchor) {
var parent = $(anchor).parent();
if (parent.find('li.show').length > 0) {
parent.addClass(show);
parent.addClass(filtered);
parent.removeClass(hide);
} else {
parent.addClass(hide);
parent.removeClass(show);
parent.removeClass(filtered);
}
})
function filterNavItem(name, text) {
if (!text) return true;
if (name.toLowerCase().indexOf(text.toLowerCase()) > -1) return true;
return false;
}
});
}
function loadToc() {
var tocPath = $("meta[property='docfx\\:tocrel']").attr("content");
if (!tocPath) {
return;
}
tocPath = tocPath.replace(/\\/g, '/');
$('#sidetoc').load(tocPath + " #sidetoggle > div", function () {
var index = tocPath.lastIndexOf('/');
var tocrel = '';
if (index > -1) {
tocrel = tocPath.substr(0, index + 1);
}
var currentHref = util.getAbsolutePath(window.location.pathname);
$('#sidetoc').find('a[href]').each(function (i, e) {
var href = $(e).attr("href");
if (util.isRelativePath(href)) {
href = tocrel + href;
$(e).attr("href", href);
}
if (util.getAbsolutePath(e.href) === currentHref) {
$(e).addClass(active);
}
$(e).text(function (index, text) {
return util.breakText(text);
})
});
renderSidebar();
});
}
}
function renderBreadcrumb() {
var breadcrumb = [];
$('#navbar a.active').each(function (i, e) {
breadcrumb.push({
href: e.href,
name: e.innerHTML
});
})
$('#toc a.active').each(function (i, e) {
breadcrumb.push({
href: e.href,
name: e.innerHTML
});
})
var html = util.formList(breadcrumb, 'breadcrumb');
$('#breadcrumb').html(html);
}
//Setup Affix
function renderAffix() {
var hierarchy = getHierarchy();
if (hierarchy.length > 0) {
var html = '<h5 class="title">In This Article</h5>'
html += util.formList(hierarchy, ['nav', 'bs-docs-sidenav']);
$("#affix").empty().append(html);
if ($('footer').is(':visible')) {
$(".sideaffix").css("bottom", "70px");
}
$('#affix').on('activate.bs.scrollspy', function (e) {
if (e.target) {
if ($(e.target).find('li.active').length > 0) {
return;
}
var top = $(e.target).position().top;
$(e.target).parents('li').each(function (i, e) {
top += $(e).position().top;
});
var container = $('#affix > ul');
var height = container.height();
container.scrollTop(container.scrollTop() + top - height / 2);
}
})
}
function getHierarchy() {
// supported headers are h1, h2, h3, and h4
// The topest header is ignored
var selector = ".article article";
var affixSelector = "#affix";
var headers = ['h4', 'h3', 'h2', 'h1'];
var hierarchy = [];
var toppestIndex = -1;
var startIndex = -1;
// 1. get header hierarchy
for (var i = headers.length - 1; i >= 0; i--) {
var header = $(selector + " " + headers[i]);
var length = header.length;
// If contains no header in current selector, find the next one
if (length === 0) continue;
// If the toppest header contains only one item, e.g. title, ignore
if (length === 1 && hierarchy.length === 0 && toppestIndex < 0) {
toppestIndex = i;
continue;
}
// Get second level children
var nextLevelSelector = i > 0 ? headers[i - 1] : null;
var prevSelector;
for (var j = length - 1; j >= 0; j--) {
var e = header[j];
var id = e.id;
if (!id) continue; // For affix, id is a must-have
var item = {
name: htmlEncode($(e).text()),
href: "#" + id,
items: []
};
if (nextLevelSelector) {
var selector = '#' + cssEscape(id) + "~" + nextLevelSelector;
var currentSelector = selector;
if (prevSelector) currentSelector += ":not(" + prevSelector + ")";
$(header[j]).siblings(currentSelector).each(function (index, e) {
if (e.id) {
item.items.push({
name: htmlEncode($(e).text()), // innerText decodes text while innerHTML not
href: "#" + e.id
})
}
})
prevSelector = selector;
}
hierarchy.push(item);
}
break;
};
hierarchy.reverse();
return hierarchy;
}
function htmlEncode(str) {
if (!str) return str;
return str
.replace(/&/g, '&amp;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&#39;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
}
function htmlDecode(value) {
if (!str) return str;
return value
.replace(/&quot;/g, '"')
.replace(/&#39;/g, "'")
.replace(/&lt;/g, '<')
.replace(/&gt;/g, '>')
.replace(/&amp;/g, '&');
}
function cssEscape(str) {
// see: http://stackoverflow.com/questions/2786538/need-to-escape-a-special-character-in-a-jquery-selector-string#answer-2837646
if (!str) return str;
return str
.replace(/[!"#$%&'()*+,.\/:;<=>?@[\\\]^`{|}~]/g, "\\$&");
}
}
// Show footer
function renderFooter() {
initFooter();
$(window).on("scroll", showFooterCore);
function initFooter() {
if (needFooter()) {
shiftUpBottomCss();
$("footer").show();
} else {
resetBottomCss();
$("footer").hide();
}
}
function showFooterCore() {
if (needFooter()) {
shiftUpBottomCss();
$("footer").fadeIn();
} else {
resetBottomCss();
$("footer").fadeOut();
}
}
function needFooter() {
var scrollHeight = $(document).height();
var scrollPosition = $(window).height() + $(window).scrollTop();
return (scrollHeight - scrollPosition) < 1;
}
function resetBottomCss() {
$(".sidetoc").removeClass("shiftup");
$(".sideaffix").removeClass("shiftup");
}
function shiftUpBottomCss() {
$(".sidetoc").addClass("shiftup");
$(".sideaffix").addClass("shiftup");
}
}
function renderLogo() {
// For LOGO SVG
// Replace SVG with inline SVG
// http://stackoverflow.com/questions/11978995/how-to-change-color-of-svg-image-using-css-jquery-svg-image-replacement
jQuery('img.svg').each(function () {
var $img = jQuery(this);
var imgID = $img.attr('id');
var imgClass = $img.attr('class');
var imgURL = $img.attr('src');
jQuery.get(imgURL, function (data) {
// Get the SVG tag, ignore the rest
var $svg = jQuery(data).find('svg');
// Add replaced image's ID to the new SVG
if (typeof imgID !== 'undefined') {
$svg = $svg.attr('id', imgID);
}
// Add replaced image's classes to the new SVG
if (typeof imgClass !== 'undefined') {
$svg = $svg.attr('class', imgClass + ' replaced-svg');
}
// Remove any invalid XML tags as per http://validator.w3.org
$svg = $svg.removeAttr('xmlns:a');
// Replace image with new SVG
$img.replaceWith($svg);
}, 'xml');
});
}
function utility() {
this.getAbsolutePath = getAbsolutePath;
this.isRelativePath = isRelativePath;
this.isAbsolutePath = isAbsolutePath;
this.getDirectory = getDirectory;
this.formList = formList;
this.breakText = breakText;
function getAbsolutePath(href) {
// Use anchor to normalize href
var anchor = $('<a href="' + href + '"></a>')[0];
// Ignore protocal, remove search and query
return anchor.host + anchor.pathname;
}
function isRelativePath(href) {
return !isAbsolutePath(href);
}
function isAbsolutePath(href) {
return (/^(?:[a-z]+:)?\/\//i).test(href);
}
function getDirectory(href) {
if (!href) return '';
var index = href.lastIndexOf('/');
if (index == -1) return '';
if (index > -1) {
return href.substr(0, index);
}
}
function formList(item, classes) {
var level = 1;
var model = {
items: item
};
var cls = [].concat(classes).join(" ");
return getList(model, cls);
function getList(model, cls) {
if (!model || !model.items) return null;
var l = model.items.length;
if (l === 0) return null;
var html = '<ul class="level' + level + ' ' + (cls || '') + '">';
level++;
for (var i = 0; i < l; i++) {
var item = model.items[i];
var href = item.href;
var name = item.name;
if (!name) continue;
html += href ? '<li><a href="' + href + '">' + name + '</a>' : '<li>' + name;
html += getList(item, cls) || '';
html += '</li>';
}
html += '</ul>';
return html;
}
}
function breakText(text) {
if (!text) return text;
return text.replace(/([a-z])([A-Z])|(\.)(\w)/g, '$1$3\u200B$2$4')
}
}
})

1466
styles/docfx.vendor.css Normal file

File diff suppressed because it is too large Load Diff

44
styles/docfx.vendor.js Normal file

File diff suppressed because one or more lines are too long

2924
styles/lunr.js Normal file

File diff suppressed because it is too large Load Diff

1
styles/lunr.min.js vendored Normal file

File diff suppressed because one or more lines are too long

0
styles/main.css Normal file
View File

1
styles/main.js Normal file
View File

@@ -0,0 +1 @@
// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.

80
styles/search-worker.js Normal file
View File

@@ -0,0 +1,80 @@
(function () {
importScripts('lunr.min.js');
var lunrIndex;
var stopWords = null;
var searchData = {};
lunr.tokenizer.seperator = /[\s\-\.]+/;
var stopWordsRequest = new XMLHttpRequest();
stopWordsRequest.open('GET', '../search-stopwords.json');
stopWordsRequest.onload = function () {
if (this.status != 200) {
return;
}
stopWords = JSON.parse(this.responseText);
buildIndex();
}
stopWordsRequest.send();
var searchDataRequest = new XMLHttpRequest();
searchDataRequest.open('GET', '../index.json');
searchDataRequest.onload = function () {
if (this.status != 200) {
return;
}
searchData = JSON.parse(this.responseText);
buildIndex();
postMessage({ e: 'index-ready' });
}
searchDataRequest.send();
onmessage = function (oEvent) {
var q = oEvent.data.q;
var hits = lunrIndex.search(q);
var results = [];
hits.forEach(function (hit) {
var item = searchData[hit.ref];
results.push({ 'href': item.href, 'title': item.title, 'keywords': item.keywords });
});
postMessage({ e: 'query-ready', q: q, d: results });
}
function buildIndex() {
if (stopWords !== null && !isEmpty(searchData)) {
lunrIndex = lunr(function () {
this.pipeline.remove(lunr.stopWordFilter);
this.ref('href');
this.field('title', { boost: 50 });
this.field('keywords', { boost: 20 });
for (var prop in searchData) {
if (searchData.hasOwnProperty(prop)) {
this.add(searchData[prop]);
}
}
var docfxStopWordFilter = lunr.generateStopWordFilter(stopWords);
lunr.Pipeline.registerFunction(docfxStopWordFilter, 'docfxStopWordFilter');
this.pipeline.add(docfxStopWordFilter);
this.searchPipeline.add(docfxStopWordFilter);
});
}
}
function isEmpty(obj) {
if(!obj) return true;
for (var prop in obj) {
if (obj.hasOwnProperty(prop))
return false;
}
return true;
}
})();