Document ·, ⊠, and ⧢ operators

Author: d-torrance

M2/Macaulay2/m2/help.m2

@@ -293,6 +293,14 @@ documentationValue(Symbol, Package)         := (S, pkg) -> if pkg =!= Core then
 -- Handling operators
 -----------------------------------------------------------------------------
 
+-- for each unicode operator, we give a pair:
+-- * unicode name
+-- * TeX name (for emacs TeX input mode -- null if not available)
+unicodeOperators := hashTable {
+    symbol · => ("middle dot", "\\cdot"),
+    symbol ⊠ => ("squared times", "\\boxtimes"),
+    symbol ⧢ => ("shuffle product",)}
+
 -- e.g. symbol +
 getOperator := key -> if operator#?key then (
     op := toString key;
@@ -321,7 +329,15 @@ getOperator := key -> if operator#?key then (
 	    PARA {"This operator may be used as a binary operator in an expression like ", TT ("x" | op | "y"), ". ",
 		"The user may ", TO2{ "Macaulay2Doc :: :=", "install a method" }, " for handling such expressions with code such as"},
 	    PRE ("         X "|op|" (x,y) -> ..."),
-	    PARA {"where ", TT "X", " is the class of ", TT "x", "."}}
+	    PARA {"where ", TT "X", " is the class of ", TT "x", "."}},
+	if unicodeOperators#?key then {
+	    PARA {"To insert this character in Emacs, you may press ", KBD "C-x 8 RET", " or ", KBD "M-x insert-char",
+		" and then enter ", format unicodeOperators#key#0, " in the minibuffer."},
+	    if (texcmd := unicodeOperators#key#1) =!= null
+	    then PARA {"Alternatively, you may press ", KBD "C-x RET C-\\", "  or ", KBD "M-x set-input-method",
+		" and then enter \"TeX\" in the minibuffer.  Afterwards, typing \"", texcmd,
+		"\" will input the character.  You may then toggle the input method using ", KBD "C-\\", " or ",
+		KBD "M-x toggle-input-method"}},
 	))
 
 -- TODO: expand this

M2/Macaulay2/packages/Macaulay2Doc/operators/tensor.m2

@@ -34,3 +34,13 @@ Node
     Example
       {1, 2} ** {10, 20, 30}
 ///
+
+document {
+    Key => symbol ⊠,
+    Headline => "a binary operator, usually used for exterior product",
+}
+
+document {
+    Key => symbol ⧢,
+    Headline => "a binary operator, usually used for shuffle product",
+}

M2/Macaulay2/packages/Macaulay2Doc/operators/times.m2

@@ -196,3 +196,8 @@ document {
 	  },
      SeeAlso => {(degree,Matrix),degrees}
      }
+
+document {
+    Key => symbol ·,
+    Headline => "a binary operator, usually used for dot product",
+}

M2/Macaulay2/packages/Macaulay2Doc/ov_language.m2

@@ -1065,6 +1065,7 @@ document {
 	  TO symbol + ,
 	  TO symbol - ,
 	  TO symbol * ,
+	  TO symbol · ,
 	  TO symbol / ,
 	  TO symbol // ,
 	  TO symbol % ,
@@ -1073,6 +1074,8 @@ document {
 	  TO symbol ++ ,
 	  TO symbol ** ,
           TO symbol ^** ,
+	  TO symbol ⊠ ,
+	  TO symbol ⧢ ,
           TO symbol ~ ,
 	  TO symbol (*) ,
           TO symbol : ,