Remove remaining occurrences of "@xxx" from non-pdf versions (#595)

* Remove occurrences of "@xxx" from non-pdf versions * Replace short space in snippets with newline * Remove default transformation for @xxx and @yyy * Remove check for "@xxx" and "@yyy" * Fix formatting * Set default value of type

Author: samuelfangjw

javascript/parseXmlLatex.js

@@ -518,7 +518,7 @@ const processTextFunctionsDefaultLatex = {
  LATEX: (node, writeTo) =>
  processTextFunctionsLatex["LATEXINLINE"](node, writeTo),
  LATEXINLINE: (node, writeTo) => {
- recursiveProcessPureText(node.firstChild, writeTo);
+ recursiveProcessPureText(node.firstChild, writeTo, { type: parseType });
  },
 
  LaTeX: (node, writeTo) => {
@@ -623,7 +623,7 @@ const processTextFunctionsDefaultLatex = {
  JAVASCRIPTINLINE: (node, writeTo) => {
  if (ancestorHasTag(node, "METAPHRASE")) {
  writeTo.push("}$");
- recursiveProcessPureText(node.firstChild, writeTo);
+ recursiveProcessPureText(node.firstChild, writeTo, { type: parseType });
  writeTo.push("$\\mathit{");
  } else {
  if (node.getAttribute("break")) {
@@ -751,7 +751,10 @@ export const processTextLatex = (node, writeTo) => {
  processTextFunctionsLatex[name](node, writeTo);
  return true;
  } else {
- if (replaceTagWithSymbol(node, writeTo) || tagsToRemove.has(name)) {
+ if (
+ replaceTagWithSymbol(node, writeTo, parseType) ||
+ tagsToRemove.has(name)
+ ) {
  return true;
  } else if (ignoreTags.has(name)) {
  recursiveProcessTextLatex(node.firstChild, writeTo);

javascript/processingFunctions/processSnippetEpub.js

@@ -28,12 +28,10 @@ export const setupSnippetsEpub = node => {
  return;
  }
  const codeArr = [];
- recursiveProcessPureText(jsRunSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ recursiveProcessPureText(jsRunSnippet.firstChild, codeArr, {
+ type: "epub"
+ });
+ const codeStr = codeArr.join("").trim();
 
  const requirements = snippet.getElementsByTagName("REQUIRES");
  const requireNames = [];
@@ -74,11 +72,7 @@ export const processSnippetEpub = (node, writeTo) => {
 
  const codeArr = [];
  recursiveProcessPureText(jsSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ const codeStr = codeArr.join("").trim();
 
  const codeArr_run = [];
  recursiveProcessPureText(jsRunSnippet.firstChild, codeArr_run);

javascript/processingFunctions/processSnippetHtml.js

@@ -29,11 +29,7 @@ export const setupSnippetsHtml = node => {
  }
  const codeArr = [];
  recursiveProcessPureText(jsRunSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ const codeStr = codeArr.join("").trim();
  const requirements = snippet.getElementsByTagName("REQUIRES");
  const requireNames = [];
  for (let i = 0; requirements[i]; i++) {
@@ -93,11 +89,7 @@ export const processSnippetHtml = (node, writeTo, split) => {
 
  const codeArr = [];
  if (jsSnippet) recursiveProcessPureText(jsSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ const codeStr = codeArr.join("").trim();
 
  const codeArr_run = [];
  if (jsRunSnippet)

javascript/processingFunctions/processSnippetJs.js

@@ -32,11 +32,7 @@ export const setupSnippetsJs = node => {
  const codeArr = [];
  recursiveProcessPureText(jsRunSnippet.firstChild, codeArr);
 
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ const codeStr = codeArr.join("").trim();
 
  const requirements = snippet.getElementsByTagName("REQUIRES");
  const requireNames = [];
@@ -87,13 +83,6 @@ export const processSnippetJs = (node, writeTo, fileFormat) => {
  jsRunSnippet = jsSnippet;
  }
  }
- const codeArr = [];
- recursiveProcessPureText(jsSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
 
  const codeArr_run = [];
  recursiveProcessPureText(jsRunSnippet.firstChild, codeArr_run);

javascript/processingFunctions/processSnippetJson.js

@@ -28,11 +28,8 @@ export const setupSnippetsJson = node => {
  }
  const codeArr = [];
  recursiveProcessPureText(jsRunSnippet.firstChild, codeArr);
- const codeStr = codeArr
- .join("")
- .replace(/@xxx\n/g, "")
- .replace(/@yyy\n/g, "")
- .trim();
+ const codeStr = codeArr.join("").trim();
+
  const requirements = snippet.getElementsByTagName("REQUIRES");
  const requireNames = [];
  for (let i = 0; requirements[i]; i++) {
@@ -84,6 +81,8 @@ export const recursivelyProcessTextSnippetJson = (node, writeTo) => {
  recursivelyProcessTextSnippetJson(node.firstChild, writeTo);
  } else if (name === "#comment" || name === "ALLOW_BREAK") {
  return;
+ } else if (name === "SHORT_SPACE" || name === "SHORT_SPACE_AND_ALLOW_BREAK") {
+ writeTo.push("\n");
  } else {
  console.log(`processSnippetJson: UNRECOGNISED TAG ${name}\n\n`);
  }
@@ -116,7 +115,8 @@ export const processSnippetJson = (node, snippet) => {
 
  const codeArr = [];
  recursiveProcessPureText(jsSnippet.firstChild, codeArr);
- let codeStr = codeArr.join("");
+ let codeStr = codeArr.join("").trim();
+
  // Remove newline from beginning and end
  codeStr = codeStr.replace(/^[\r\n]+/g, "");
  codeStr = codeStr.replace(/[\r\n\s]+$/g, "");

javascript/processingFunctions/processSnippetPdf.js

@@ -29,7 +29,9 @@ export const setupSnippetsPdf = node => {
  return;
  }
  const codeArr = [];
- recursiveProcessPureText(jsRunSnippet.firstChild, codeArr);
+ recursiveProcessPureText(jsRunSnippet.firstChild, codeArr, {
+ type: "pdf"
+ });
  const codeStr = codeArr.join("").trim();
 
  const requirements = snippet.getElementsByTagName("REQUIRES");
@@ -207,7 +209,9 @@ export const processSnippetPdf = (node, writeTo) => {
  .trim();
 
  const codeArr_run = [];
- recursiveProcessPureText(jsRunSnippet.firstChild, codeArr_run);
+ recursiveProcessPureText(jsRunSnippet.firstChild, codeArr_run, {
+ type: "pdf"
+ });
  const codeStr_run = codeArr_run.join("").trim();
 
  // Do warning for very long lines if no latex

javascript/processingFunctions/recursiveProcessPureText.js

@@ -1,14 +1,18 @@
 import replaceTagWithSymbol from "./replaceTagWithSymbol";
 
-const recursiveProcessPureTextDefault = { removeNewline: false };
+const recursiveProcessPureTextDefault = { removeNewline: false, type: false };
 
 const recursiveProcessPureText = (
  node,
  writeTo,
  options = recursiveProcessPureTextDefault
 ) => {
  if (!node) return;
- if (!replaceTagWithSymbol(node, writeTo) && node.nodeName === "#text") {
+
+ if (
+ !replaceTagWithSymbol(node, writeTo, options.type) &&
+ node.nodeName === "#text"
+ ) {
  let value = node.nodeValue;
  if (options.removeNewline == "beginning&end") {
  value = value.replace(/^[\r\n]+/g, "");

javascript/processingFunctions/replaceTagWithSymbol.js

@@ -1,4 +1,4 @@
-const tagsToReplace = {
+const tagsToReplaceDefault = {
  APOS: "'",
  WJ: "⁠",
  AACUTE_LOWER: "á",
@@ -22,8 +22,8 @@ const tagsToReplace = {
  SHARP: "\\#",
  SECT: "§",
 
- SHORT_SPACE: "@xxx", // will be replaced in processSnippet depending on rendering target (PDF, HTML, etc.)
- SHORT_SPACE_AND_ALLOW_BREAK: "@yyy", // will be replaced in processSnippet depending on rendering target (PDF, HTML, etc.)
+ SHORT_SPACE: "",
+ SHORT_SPACE_AND_ALLOW_BREAK: "",
 
  EMDASH: "—",
  ENDASH: "–",
@@ -34,8 +34,23 @@ const tagsToReplace = {
  FIXED_SPACE: "{\\tt~}"
 };
 
-export const replaceTagWithSymbol = (node, writeTo) => {
+const tagsToReplacePdf = {
+ SHORT_SPACE: "@xxx", // will be replaced in processSnippet
+ SHORT_SPACE_AND_ALLOW_BREAK: "@yyy" // will be replaced in processSnippet
+};
+
+export const replaceTagWithSymbol = (node, writeTo, type = "default") => {
  const name = node.nodeName;
+ let tagsToReplace;
+
+ switch (type) {
+ case "pdf":
+ tagsToReplace = { ...tagsToReplaceDefault, ...tagsToReplacePdf };
+ break;
+ default:
+ tagsToReplace = tagsToReplaceDefault;
+ }
+
  if (tagsToReplace[name]) {
  writeTo.push(tagsToReplace[name]);
  return true;