aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/sphinx/_static/notations.js
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/_static/notations.js')
-rw-r--r--doc/sphinx/_static/notations.js43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/sphinx/_static/notations.js b/doc/sphinx/_static/notations.js
new file mode 100644
index 000000000..eb7f211e8
--- /dev/null
+++ b/doc/sphinx/_static/notations.js
@@ -0,0 +1,43 @@
+/************************************************************************/
+/* * The Coq Proof Assistant / The Coq Development Team */
+/* v * INRIA, CNRS and contributors - Copyright 1999-2018 */
+/* <O___,, * (see CREDITS file for the list of authors) */
+/* \VV/ **************************************************************/
+/* // * This file is distributed under the terms of the */
+/* * GNU Lesser General Public License Version 2.1 */
+/* * (see LICENSE file for the text of the license) */
+/************************************************************************/
+function annotateSup(marker) {
+ switch (marker) {
+ case "?":
+ return "This block is optional.";
+ case "*":
+ return "This block is optional, and may be repeated.";
+ case "+":
+ return "This block may be repeated.";
+ }
+}
+
+function annotateSub(separator) {
+ return "Use “" + separator + "” to separate repetitions of this block.";
+}
+
+// function translatePunctuation(original) {
+// var mappings = { ",": "⸴" }; // ,
+// return mappings[original] || original;
+// }
+
+function annotateNotations () {
+ $(".repeat-wrapper > sup")
+ .attr("data-hint", function() {
+ return annotateSup($(this).text());
+ }).addClass("hint--top hint--rounded");
+
+ $(".repeat-wrapper > sub")
+ .attr("data-hint", function() {
+ return annotateSub($(this).text());
+ }).addClass("hint--bottom hint--rounded");
+ //.text(function(i, text) { return translatePunctuation(text); });
+}
+
+$(annotateNotations);