github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-07 20:31:06 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fix log hints for IE 11 (#3507)

Browse source 
* Fix log hints for IE 11

* Address PR feedback

GitOrigin-RevId: d5369e3dcd42970edbcf7bbd566e6e608ab90878
This commit is contained in:
Paulo Jorge Reis 2021-01-04 10:22:57 +00:00 committed by Copybot
parent 2c556366e2
commit 0507b5e1f0
1 changed files with 111 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

151
services/web/frontend/js/ide/human-readable-logs/HumanReadableLogsRules.js
View file

@ -1,7 +1,6 @@
/* eslint-disable no-useless-escape */
import React from 'react'
import PropTypes from 'prop-types'
import ReactDOMServer from 'react-dom/server'
function WikiLink({ url, children }) {
return window.wikiEnabled ? (
@ -34,7 +33,9 @@ const rules = [
{'{tabular}'}, etc. If you want to write an ampersand '&' in text, you
must write \& instead.
</>
)
),
humanReadableHint:
'You have placed an alignment tab character &#x27;&amp;&#x27; in the wrong place. If you want to align something, you must write it inside an align environment such as \\begin{align} … \\end{align}, \\begin{tabular} … \\end{tabular}, etc. If you want to write an ampersand &#x27;&amp;&#x27; in text, you must write \\&amp; instead.'
},
{
regexToMatch: /Extra alignment tab has been changed to \\cr/,
@ -47,7 +48,9 @@ const rules = [
number of columns in your{' '}
<WikiLink url="https://www.overleaf.com/learn/Tables">table</WikiLink>.
</>
)
),
humanReadableHint:
'You have written too many alignment tabs in a table, causing one of them to be turned into a line break. Make sure you have specified the correct number of columns in your <a href="https://www.overleaf.com/learn/Tables" target="_blank">table</a>.'
},
{
regexToMatch: /Display math should end with \$\$/,
@ -59,7 +62,9 @@ const rules = [
writing in display math mode, you must always math write inside $$ … $$.
Check that the number of $s match around each math expression.
</>
)
),
humanReadableHint:
'You have forgotten a $ sign at the end of &#x27;display math&#x27; mode. When writing in display math mode, you must always math write inside $$ … $$. Check that the number of $s match around each math expression.'
},
{
regexToMatch: /Missing [{$] inserted./,
@ -80,7 +85,9 @@ const rules = [
{'{math}'} … \end
{'{math}'}.
</>
)
),
humanReadableHint:
'Check that your $&#x27;s match around math expressions. If they do, then you&#x27;ve probably used a symbol in normal text that needs to be in math mode. Symbols such as subscripts ( _ ), integrals ( \\int ), Greek letters ( \\alpha, \\beta, \\delta ), and modifiers (\\vec{x}, \\tilde{x} ) must be written in math mode. See the full list <a href="https://www.overleaf.com/learn/Errors/Missing_$_inserted" target="_blank">here</a>. If you intended to use mathematics mode, then use $ … $ for &#x27;inline math mode&#x27;, $$ … $$ for &#x27;display math mode&#x27; or alternatively \\begin{math} … \\end{math}.'
},
{
regexToMatch: /(undefined )?[rR]eference(s)?.+(undefined)?/,
@ -93,7 +100,9 @@ const rules = [
{'{...}'} is the same as what is written inside \label
{'{...}'}.
</>
)
),
humanReadableHint:
'You have referenced something which has not yet been labelled. If you have labelled it already, make sure that what is written inside \\ref{...} is the same as what is written inside \\label{...}.'
},
{
regexToMatch: /Citation .+ on page .+ undefined on input line .+/,
@ -106,7 +115,9 @@ const rules = [
{'{...}'}) has a corresponding key in your bibliography, and that both
are spelled the same way.
</>
)
),
humanReadableHint:
'You have cited something which is not included in your bibliography. Make sure that the citation (\\cite{...}) has a corresponding key in your bibliography, and that both are spelled the same way.'
},
{
regexToMatch: /(Label .+)? multiply[ -]defined( labels)?/,
@ -117,7 +128,9 @@ const rules = [
You have used the same label more than once. Check that each \label
{'{...}'} labels only one item.
</>
)
),
humanReadableHint:
'You have used the same label more than once. Check that each \\label{...} labels only one item.'
},
{
regexToMatch: /`!?h' float specifier changed to `!?ht'/,
@ -134,7 +147,9 @@ const rules = [
</WikiLink>
.
</>
)
),
humanReadableHint:
'The float specifier &#x27;h&#x27; is too strict of a demand for LaTeX to place your float in a nice way here. Try relaxing it by using &#x27;ht&#x27;, or even &#x27;htbp&#x27; if necessary. If you want to try keep the float here anyway, check out the <a href="https://www.overleaf.com/learn/Positioning_of_Figures" target="_blank">float package</a>.'
},
{
regexToMatch: /No positions in optional float specifier/,
@ -154,7 +169,9 @@ const rules = [
</WikiLink>
.
</>
)
),
humanReadableHint:
'You have forgotten to include a float specifier, which tells LaTeX where to position your figure. To fix this, either insert a float specifier inside the square brackets (e.g. \\begin{figure}[h]), or remove the square brackets (e.g. \\begin{figure}). Find out more about float specifiers <a href="https://www.overleaf.com/learn/Positioning_of_Figures" target="_blank">here</a>.'
},
{
regexToMatch: /Undefined control sequence/,
@ -168,7 +185,9 @@ const rules = [
\usepackage
{'{...}'}.
</>
)
),
humanReadableHint:
'The compiler is having trouble understanding a command you have used. Check that the command is spelled correctly. If the command is part of a package, make sure you have included the package in your preamble using \\usepackage{...}.'
},
{
regexToMatch: /File .+ not found/,
@ -187,7 +206,9 @@ const rules = [
</WikiLink>
.
</>
)
),
humanReadableHint:
'The compiler cannot find the file you want to include. Make sure that you have <a href="https://www.overleaf.com/learn/Including_images_in_ShareLaTeX" target="_blank">uploaded the file</a> and <a href="https://www.overleaf.com/learn/Errors/File_XXX_not_found_on_input_line_XXX." target="_blank">specified the file location correctly</a>.'
},
{
regexToMatch: /LaTeX Error: Unknown graphics extension: \..+/,
@ -203,7 +224,9 @@ const rules = [
for your choice of compiler, and check that there are no periods (.) in
the name of your image.
</>
)
),
humanReadableHint:
'The compiler does not recognise the file type of one of your images. Make sure you are using a <a href="https://www.overleaf.com/learn/Errors/LaTeX_Error:_Unknown_graphics_extension:_.gif." target="_blank">supported image format</a> for your choice of compiler, and check that there are no periods (.) in the name of your image.'
},
{
regexToMatch: /LaTeX Error: Unknown float option `H'/,
@ -214,7 +237,9 @@ const rules = [
The compiler isn't recognizing the float option 'H'. Include \usepackage
{'{float}'} in your preamble to fix this.
</>
)
),
humanReadableHint:
'The compiler isn&#x27;t recognizing the float option &#x27;H&#x27;. Include \\usepackage{float} in your preamble to fix this.'
},
{
regexToMatch: /LaTeX Error: Unknown float option `q'/,
@ -230,7 +255,9 @@ const rules = [
</WikiLink>{' '}
.
</>
)
),
humanReadableHint:
'You have used a float specifier which the compiler does not understand. You can learn more about the different float options available for placing figures <a href="https://www.overleaf.com/learn/Positioning_of_Figures" target="_blank">here</a> .'
},
{
regexToMatch: /LaTeX Error: \\math.+ allowed only in math mode/,
@ -245,7 +272,9 @@ const rules = [
). If you want to use it outside of math mode, use the text version
instead: \textrm, \textit, etc.
</>
)
),
humanReadableHint:
'You have used a font command which is only available in math mode. To use this command, you must be in maths mode (E.g. $ … $ or \\begin{math} … \\end{math}). If you want to use it outside of math mode, use the text version instead: \\textrm, \\textit, etc.'
},
{
ruleId: 'hint_mismatched_environment',
@ -258,7 +287,9 @@ const rules = [
{'{...}'} without a corresponding \end
{'{...}'}.
</>
)
),
humanReadableHint:
'You have used \\begin{...} without a corresponding \\end{...}.'
},
{
ruleId: 'hint_mismatched_brackets',
@ -267,7 +298,9 @@ const rules = [
newMessage: "Error: brackets do not match, found '$2' instead of '$1'",
humanReadableHintComponent: (
<>You have used an open bracket without a corresponding close bracket.</>
)
),
humanReadableHint:
'You have used an open bracket without a corresponding close bracket.'
},
{
regexToMatch: /LaTeX Error: Can be used only in preamble/,
@ -281,7 +314,9 @@ const rules = [
{'{…}'} commands are written before \begin
{'{document}'}.
</>
)
),
humanReadableHint:
'You have used a command in the main body of your document which should be used in the preamble. Make sure that \\documentclass[…]{…} and all \\usepackage{…} commands are written before \\begin{document}.'
},
{
regexToMatch: /Missing \\right inserted/,
@ -298,7 +333,9 @@ const rules = [
</WikiLink>
.
</>
)
),
humanReadableHint:
'You have started an expression with a \\left command, but have not included a corresponding \\right command. Make sure that your \\left and \\right commands balance everywhere, or else try using \\Biggl and \\Biggr commands instead as shown <a href="https://www.overleaf.com/learn/Errors/Missing_%5Cright_inserted" target="_blank">here</a>.'
},
{
regexToMatch: /Double superscript/,
@ -310,7 +347,9 @@ const rules = [
when using multiple superscripts. Try a^
{'{b ^ c}'} instead.
</>
)
),
humanReadableHint:
'You have written a double superscript incorrectly as a^b^c, or else you have written a prime with a superscript. Remember to include {and} when using multiple superscripts. Try a^{b ^ c} instead.'
},
{
regexToMatch: /Double subscript/,
@ -321,7 +360,9 @@ const rules = [
include {'{and}'} when using multiple subscripts. Try a_
{'{b_c}'} instead.
</>
)
),
humanReadableHint:
'You have written a double subscript incorrectly as a_b_c. Remember to include {and} when using multiple subscripts. Try a_{b_c} instead.'
},
{
regexToMatch: /No \\author given/,
@ -333,7 +374,9 @@ const rules = [
\author
{'{…}'} command.
</>
)
),
humanReadableHint:
'You have used the \\maketitle command, but have not specified any \\author. To fix this, include an author in your preamble using the \\author{…} command.'
},
{
regexToMatch: /LaTeX Error: Environment .+ undefined/,
@ -347,7 +390,9 @@ const rules = [
the required package for that environment in your preamble, and that the
environment is spelled correctly.
</>
)
),
humanReadableHint:
'You have created an environment (using \\begin{…} and \\end{…} commands) which is not recognized. Make sure you have included the required package for that environment in your preamble, and that the environment is spelled correctly.'
},
{
regexToMatch: /LaTeX Error: Something's wrong--perhaps a missing \\item/,
@ -359,7 +404,9 @@ const rules = [
label list entries using the \item command, and that you have not used a
list inside a table.
</>
)
),
humanReadableHint:
'There are no entries found in a list you have created. Make sure you label list entries using the \\item command, and that you have not used a list inside a table.'
},
{
regexToMatch: /Misplaced \\noalign/,
@ -370,7 +417,9 @@ const rules = [
table. If the \hline command is written inside a table, try including \\
before it.
</>
)
),
humanReadableHint:
'You have used a \\hline command in the wrong place, probably outside a table. If the \\hline command is written inside a table, try including \\\\ before it.'
},
{
regexToMatch: /LaTeX Error: There's no line here to end/,
@ -382,7 +431,9 @@ const rules = [
one. Make sure that you only use line breaks after blocks of text, and
be careful using linebreaks inside lists and other environments.\
</>
)
),
humanReadableHint:
'You have used a \\\\ or \\newline command where LaTeX was not expecting one. Make sure that you only use line breaks after blocks of text, and be careful using linebreaks inside lists and other environments.\\'
},
{
regexToMatch: /LaTeX Error: \\verb ended by end of line/,
@ -397,7 +448,9 @@ const rules = [
{'{verbatim}'}
.\
</>
)
),
humanReadableHint:
'You have used a \\verb command incorrectly. Try replacling the \\verb command with \\begin{verbatim}…\\end{verbatim}.\\'
},
{
regexToMatch: /Illegal unit of measure (pt inserted)/,
@ -409,7 +462,9 @@ const rules = [
(pt, mm, cm etc.). If you have not written a length, check that you have
not witten a linebreak \\ followed by square brackets […] anywhere.
</>
)
),
humanReadableHint:
'You have written a length, but have not specified the appropriate units (pt, mm, cm etc.). If you have not written a length, check that you have not witten a linebreak \\\\ followed by square brackets […] anywhere.'
},
{
regexToMatch: /Extra \\right/,
@ -419,7 +474,9 @@ const rules = [
You have written a \right command without a corresponding \left command.
Check that all \left and \right commands balance everywhere.
</>
)
),
humanReadableHint:
'You have written a \\right command without a corresponding \\left command. Check that all \\left and \\right commands balance everywhere.'
},
{
regexToMatch: /Missing \\begin{document}/,
@ -432,7 +489,9 @@ const rules = [
{'{document}'} in your preamble, and that your main document is set
correctly.
</>
)
),
humanReadableHint:
'No \\begin{document} command was found. Make sure you have included \\begin{document} in your preamble, and that your main document is set correctly.'
},
{
ruleId: 'hint_mismatched_environment2',
@ -446,7 +505,9 @@ const rules = [
{'{}'} without a corresponding \end
{'{}'}.
</>
)
),
humanReadableHint:
'You have used \\begin{} without a corresponding \\end{}.'
},
{
ruleId: 'hint_mismatched_environment3',
@ -460,7 +521,9 @@ const rules = [
{'{}'} without a corresponding \end
{'{}'}.
</>
)
),
humanReadableHint:
'You have used \\begin{} without a corresponding \\end{}.'
},
{
ruleId: 'hint_mismatched_environment4',
@ -474,15 +537,23 @@ const rules = [
{'{}'} without a corresponding \end
{'{}'}.
</>
)
),
humanReadableHint:
'You have used \\begin{} without a corresponding \\end{}.'
}
]
rules.forEach(rule => {
rule.humanReadableHint = ReactDOMServer.renderToStaticMarkup(
rule.humanReadableHintComponent
)
rule.extraInfoURL = window.wikiEnabled ? rule.extraInfoURL : null
})
if (!window.wikiEnabled) {
rules.forEach(rule => {
rule.extraInfoURL = null
rule.humanReadableHint = stripHTMLFromString(rule.humanReadableHint)
})
}
function stripHTMLFromString(htmlStr) {
const tmp = document.createElement('DIV')
tmp.innerHTML = htmlStr
return tmp.textContent || tmp.innerText || ''
}
export default rules