Add Help dialog box (rather than link to a site). Fix Markdown to substitue values for URL's in links.

This commit is contained in:
Davide P. Cervone 2013-04-22 13:18:58 -04:00
parent f04a2e3037
commit 3901529db9
6 changed files with 298 additions and 9 deletions

View File

@ -730,7 +730,7 @@ MathJax.fileversion = "2.1.2";
script: script script: script
}; };
// Add this to the structure above after it is created to prevent recursion // Add this to the structure above after it is created to prevent recursion
// when loading the initial localiation file (before loading messsage is available) // when loading the initial localization file (before loading messsage is available)
this.loading[file].message = BASE.Message.File(file); this.loading[file].message = BASE.Message.File(file);
script.onerror = timeout; // doesn't work in IE and no apparent substitute script.onerror = timeout; // doesn't work in IE and no apparent substitute
script.type = "text/javascript"; script.type = "text/javascript";
@ -1215,7 +1215,7 @@ MathJax.Localization = {
// //
data = this.processString(parts[i+5],args,domain); data = this.processString(parts[i+5],args,domain);
if (!(data instanceof Array)) {data = [data]} if (!(data instanceof Array)) {data = [data]}
data = ["a",{href:parts[i+6],target:"_blank"},data]; data = ["a",{href:this.processString(parts[i+6],args),target:"_blank"},data];
} else { } else {
// //
// Escaped character (%c) gets added into the string. // Escaped character (%c) gets added into the string.

View File

@ -0,0 +1,151 @@
/* -*- Mode: Javascript; indent-tabs-mode:nil; js-indent-level: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/*************************************************************
*
* MathJax/extensions/HelpDialog.js
*
* Implements the MathJax Help dialog box.
*
* ---------------------------------------------------------------------
*
* Copyright (c) 2013 Design Science, Inc.
*
* Licensed 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.
*/
(function (HUB,HTML,AJAX,OUTPUT) {
var HELP = MathJax.Extension.Help = {
version: "2.1"
};
var STIXURL = "http://www.stixfonts.org/";
var MENU = MathJax.Menu;
var CONFIG = HUB.CombineConfig("HelpDialog",{
closeImg: AJAX.fileURL(OUTPUT.imageDir+"/CloseX-31.png"), // image for close "X" for mobiles
styles: {
"#MathJax_Help": {
position:"fixed", left:"50%", width:"auto", "max-width": "90%", "text-align":"center",
border:"3px outset", padding:"1em 2em", "background-color":"#DDDDDD", color:"black",
cursor: "default", "font-family":"message-box", "font-size":"120%",
"font-style":"normal", "text-indent":0, "text-transform":"none",
"line-height":"normal", "letter-spacing":"normal", "word-spacing":"normal",
"word-wrap":"normal", "white-space":"wrap", "float":"none", "z-index":201,
"border-radius": "15px", // Opera 10.5 and IE9
"-webkit-border-radius": "15px", // Safari and Chrome
"-moz-border-radius": "15px", // Firefox
"-khtml-border-radius": "15px", // Konqueror
"box-shadow":"0px 10px 20px #808080", // Opera 10.5 and IE9
"-webkit-box-shadow":"0px 10px 20px #808080", // Safari 3 and Chrome
"-moz-box-shadow":"0px 10px 20px #808080", // Forefox 3.5
"-khtml-box-shadow":"0px 10px 20px #808080", // Konqueror
filter: "progid:DXImageTransform.Microsoft.dropshadow(OffX=2, OffY=2, Color='gray', Positive='true')" // IE
},
"#MathJax_HelpContent": {
overflow:"auto", "text-align":"left", "font-size":"80%",
padding:".4em .6em", border:"1px inset", margin:"1em 0px",
"max-height":"20em", "max-width":"30em", "background-color":"#EEEEEE"
}
}
});
/*
* Handle the Help Dialog box
*/
HELP.Dialog = function () {
this.div = MENU.Background(this);
var help = HTML.addElement(this.div,"div",{
id: "MathJax_Help"
},MathJax.Localization._("HelpDialog",[
["b",{style:{fontSize:"120%"}},[["Help","MathJax Help"]]],
["div",{id: "MathJax_HelpContent"},[
["p",{},[["MathJax",
"*MathJax* is a JavaScript library that allows page authors to include " +
"mathematics within their web pages. As a reader, you don't need to do " +
"anything to make that happen."]]
],
["p",{},[["Browsers",
"*Browsers*: MathJax works with all modern browsers including IE6+, Firefox 3+, " +
"Chrome 0.2+, Safari 2+, Opera 9.6+ and most mobile browsers."]]
],
["p",{},[["Menu",
"*Math Menu*: MathJax adds a contextual menu to equations. Right-click or " +
"CTRL-click on any mathematics to access the menu."]]
],
["div",{style:{"margin-left":"1em"}},[
["p",{},[["ShowMath",
"*Show Math As* allows you to view the formula's source markup " +
"for copy & paste (as MathML or in its origianl format)."]]
],
["p",{},[["Settings",
"*Settings* gives you control over features of MathJax, such as the " +
"size of the mathematics, and the mechanism used to display equations."]]
],
["p",{},[["Language",
"*Language* lets you select the language used by MathJax for its menus " +
"and warning messages."]]
],
]],
["p",{},[["Zoom",
"*Math Zoom*: If you are having difficulty reading an equation, MathJax can " +
"enlarge it to help you see it better."]]
],
["p",{},[["Accessibilty",
"*Accessibility*: MathJax will automatically work with screen readers to make " +
"mathematics accessible to the visually impaired."]]
],
["p",{},[["Fonts",
"*Fonts*: MathJax will use certain math fonts if they are installed on your " +
"computer; otherwise, it will use web-based fonts. Although not required, " +
"locally installed fonts will speed up typesetting. We suggest installing " +
"the [STIX fonts](%1).",STIXURL]]
]
]],
["a",{href:"http://www.mathjax.org/"},["www.mathjax.org"]],
["img", {
src: CONFIG.closeImg,
style: {width:"21px", height:"21px", position:"absolute", top:".2em", right:".2em"},
onclick: HELP.Remove
}]
]));
MathJax.Localization.setCSS(help);
var doc = (document.documentElement||{});
var H = window.innerHeight || doc.clientHeight || doc.scrollHeight || 0;
if (MENU.prototype.msieAboutBug) {
help.style.width = "20em"; help.style.position = "absolute";
help.style.left = Math.floor((document.documentElement.scrollWidth - help.offsetWidth)/2)+"px";
help.style.top = (Math.floor((H-help.offsetHeight)/3)+document.body.scrollTop)+"px";
} else {
help.style.marginLeft = Math.floor(-help.offsetWidth/2)+"px";
help.style.top = Math.floor((H-help.offsetHeight)/3)+"px";
}
};
HELP.Remove = function (event) {
if (HELP.div) {document.body.removeChild(HELP.div); delete HELP.div}
};
MathJax.Callback.Queue(
HUB.Register.StartupHook("End Config",{}), // wait until config is complete
["Styles",AJAX,CONFIG.styles],
["loadDomain",MathJax.Localization,"HelpDialog"],
["Post",HUB.Startup.signal,"HelpDialig Ready"],
["loadComplete",AJAX,"[MathJax]/extensions/HelpDialog.js"]
);
})(MathJax.Hub,MathJax.HTML,MathJax.Ajax,MathJax.OutputJax);

View File

@ -48,7 +48,6 @@
var CONFIG = HUB.CombineConfig("MathMenu",{ var CONFIG = HUB.CombineConfig("MathMenu",{
delay: 150, // the delay for submenus delay: 150, // the delay for submenus
helpURL: "http://www.mathjax.org/help-v2/user/", // the URL for the "MathJax Help" menu
closeImg: AJAX.fileURL(OUTPUT.imageDir+"/CloseX-31.png"), // image for close "X" for mobiles closeImg: AJAX.fileURL(OUTPUT.imageDir+"/CloseX-31.png"), // image for close "X" for mobiles
showRenderer: true, // show the "Math Renderer" menu? showRenderer: true, // show the "Math Renderer" menu?
@ -331,12 +330,12 @@
var div = HTML.addElement(document.body,"div",{style:this.BGSTYLE, id:"MathJax_MenuFrame"}, var div = HTML.addElement(document.body,"div",{style:this.BGSTYLE, id:"MathJax_MenuFrame"},
[["div",{style: this.BGSTYLE, menuItem: menu, onmousedown: this.Remove}]]); [["div",{style: this.BGSTYLE, menuItem: menu, onmousedown: this.Remove}]]);
var bg = div.firstChild; var bg = div.firstChild;
if (menu.msieBackgroundBug) { if (MENU.msieBackgroundBug) {
// MSIE doesn't allow transparent background to be hit boxes, so // MSIE doesn't allow transparent background to be hit boxes, so
// fake it using opacity with solid background color // fake it using opacity with solid background color
bg.style.backgroundColor = "white"; bg.style.filter = "alpha(opacity=0)"; bg.style.backgroundColor = "white"; bg.style.filter = "alpha(opacity=0)";
} }
if (menu.msieFixedPositionBug) { if (MENU.msieFixedPositionBug) {
// MSIE can't do fixed position, so use a full-sized background // MSIE can't do fixed position, so use a full-sized background
// and an onresize handler to update it (stupid, but necessary) // and an onresize handler to update it (stupid, but necessary)
div.width = div.height = 0; this.Resize(); div.width = div.height = 0; this.Resize();
@ -615,9 +614,6 @@
/* /*
* Handle the ABOUT box * Handle the ABOUT box
*/ */
// Localization: need to be reorganized. currently, there are concatenation
// of HTMLCSS.fontInUse and English strings based on the values of
// HTMLCSS.webFonts and HTMLCSS.imgFonts, HTMLCSS.allowWebFonts etc
MENU.About = function () { MENU.About = function () {
var HTMLCSS = OUTPUT["HTML-CSS"] || {}; var HTMLCSS = OUTPUT["HTML-CSS"] || {};
var font = var font =
@ -687,7 +683,8 @@
* Handle the MathJax HELP menu * Handle the MathJax HELP menu
*/ */
MENU.Help = function () { MENU.Help = function () {
window.open(CONFIG.helpURL,"MathJaxHelp"); AJAX.Require("[MathJax]/extensions/HelpDialog.js",
function () {MathJax.Extension.Help.Dialog()});
}; };
/* /*

View File

@ -0,0 +1,47 @@
MathJax.Localization.addTranslation("de","HelpDialog",{
isLoaded: true,
strings: {
MathJax:
"*MathJax* is a JavaScript library that allows page authors to include " +
"mathematics within their web pages. As a reader, you don't need to do " +
"anything to make that happen.",
Browsers:
"*Browsers*: MathJax works with all modern browsers including IE6+, Firefox 3+, " +
"Chrome 0.2+, Safari 2+, Opera 9.6+ and most mobile browsers.",
Menu:
"*Math Menu*: MathJax adds a contextual menu to equations. Right-click or " +
"CTRL-click on any mathematics to access the menu.",
ShowMath:
"*Show Math As* allows you to view the formula's source markup " +
"for copy & paste (as MathML or in its origianl format).",
Settings:
"*Settings* gives you control over features of MathJax, such as the " +
"size of the mathematics, and the mechanism used to display equations.",
Language:
"*Language* lets you select the language used by MathJax for its menus " +
"and warning messages.",
Zoom:
"*Math Zoom*: If you are having difficulty reading an equation, MathJax can " +
"enlarge it to help you see it better.",
Accessibilty:
"*Accessibility*: MathJax will automatically work with screen readers to make " +
"mathematics accessible to the visually impaired.",
Fonts:
"*Fonts*: MathJax will use certain math fonts if they are installed on your " +
"computer; otherwise, it will use web-based fonts. Although not required, " +
"locally installed fonts will speed up typesetting. We suggest installing " +
"the [STIX fonts](%1)."
}
});
MathJax.Ajax.loadComplete("[MathJax]/localization/de/HelpDialog.js");

View File

@ -0,0 +1,47 @@
MathJax.Localization.addTranslation("en","HelpDialog",{
isLoaded: true,
strings: {
MathJax:
"*MathJax* is a JavaScript library that allows page authors to include " +
"mathematics within their web pages. As a reader, you don't need to do " +
"anything to make that happen.",
Browsers:
"*Browsers*: MathJax works with all modern browsers including IE6+, Firefox 3+, " +
"Chrome 0.2+, Safari 2+, Opera 9.6+ and most mobile browsers.",
Menu:
"*Math Menu*: MathJax adds a contextual menu to equations. Right-click or " +
"CTRL-click on any mathematics to access the menu.",
ShowMath:
"*Show Math As* allows you to view the formula's source markup " +
"for copy & paste (as MathML or in its origianl format).",
Settings:
"*Settings* gives you control over features of MathJax, such as the " +
"size of the mathematics, and the mechanism used to display equations.",
Language:
"*Language* lets you select the language used by MathJax for its menus " +
"and warning messages.",
Zoom:
"*Math Zoom*: If you are having difficulty reading an equation, MathJax can " +
"enlarge it to help you see it better.",
Accessibilty:
"*Accessibility*: MathJax will automatically work with screen readers to make " +
"mathematics accessible to the visually impaired.",
Fonts:
"*Fonts*: MathJax will use certain math fonts if they are installed on your " +
"computer; otherwise, it will use web-based fonts. Although not required, " +
"locally installed fonts will speed up typesetting. We suggest installing " +
"the [STIX fonts](%1)."
}
});
MathJax.Ajax.loadComplete("[MathJax]/localization/en/HelpDialog.js");

View File

@ -0,0 +1,47 @@
MathJax.Localization.addTranslation("fr","HelpDialog",{
isLoaded: true,
strings: {
MathJax:
"*MathJax* is a JavaScript library that allows page authors to include " +
"mathematics within their web pages. As a reader, you don't need to do " +
"anything to make that happen.",
Browsers:
"*Browsers*: MathJax works with all modern browsers including IE6+, Firefox 3+, " +
"Chrome 0.2+, Safari 2+, Opera 9.6+ and most mobile browsers.",
Menu:
"*Math Menu*: MathJax adds a contextual menu to equations. Right-click or " +
"CTRL-click on any mathematics to access the menu.",
ShowMath:
"*Show Math As* allows you to view the formula's source markup " +
"for copy & paste (as MathML or in its origianl format).",
Settings:
"*Settings* gives you control over features of MathJax, such as the " +
"size of the mathematics, and the mechanism used to display equations.",
Language:
"*Language* lets you select the language used by MathJax for its menus " +
"and warning messages.",
Zoom:
"*Math Zoom*: If you are having difficulty reading an equation, MathJax can " +
"enlarge it to help you see it better.",
Accessibilty:
"*Accessibility*: MathJax will automatically work with screen readers to make " +
"mathematics accessible to the visually impaired.",
Fonts:
"*Fonts*: MathJax will use certain math fonts if they are installed on your " +
"computer; otherwise, it will use web-based fonts. Although not required, " +
"locally installed fonts will speed up typesetting. We suggest installing " +
"the [STIX fonts](%1)."
}
});
MathJax.Ajax.loadComplete("[MathJax]/localization/fr/HelpDialog.js");