messages.json

{
    "README": "Warnings in this file map warning codes to short messages and extended help messages. Anything in the optional 'tex' nested object will override the values in the parent object if the document source is a LaTeX file instead of a DOCX file.",
    "warnings": {
        "unexpected": {
            "message": "Unexpected error!",
            "severity": "high",
            "help": "An unanticipated error occurred that may require improvements to the document parser used in conversion; please notify support"
        },
        "timeout": {
            "message": "Conversion time limit exceeded",
            "severity": "high",
            "help": "The conversion time limit is more than enough for successfully converted papers. If the time limit is exceeded, something unexpected is happening during conversion. Please notify support."
        },
        "make4ht_failed": {
            "message": "Document compilation failed",
            "severity": "high",
            "help": "LaTeX (make4ht, specifically) did not produce an output file. This indicates that LaTeX encountered an unrecoverable error. The last warning in the conversion log output may indicate which step failed. Often this is marked with a \"[FATAL]\" message."
        },
        "make4ht_warnings": {
            "message": "LaTeX compilation warnings; see full output (line numbers will match your source file unless you used \\input{})",
            "severity": "low",
            "help": "In most cases, LaTeX warnings are not a problem. Typically, they occur because the LaTeX HTML compiler (make4ht) does not recognize some package; \"Undefined control sequence\" warnings are especially common in this case. However, conversion will often produce a reasonable output anyway. Hence, you can ignore this warning unless there is another problem, like the document failed to compile or the output looks wrong, in which case the LaTeX warnings may be helpful."
        },
        "natbib_jedm": {
            "message": "\\usepackage{natbib} should not be specified",
            "severity": "medium",
            "help": "The JEDM template already implies natbib, and including it a second time may cause issues."
        },
        "converted_citep_citet": {
            "message": "\\citep and/or \\citet converted to \\cite",
            "severity": "low",
            "help": "\\citep and \\citet causes issues without natbib, so \\citep was automatically converted to \\cite and \\citet was redefined to (hopefully) enable correct postprocessing. If the citations and references in the result seem OK, you can ignore this message."
        },
        "converted_apacite": {
            "message": "\\shortcite {apacite} converted to \\cite",
            "severity": "low",
            "help": "The apacite package and the \\shortcite commands to not convert well to HTML, and the template does not use them. They have been automatically converted to \\cite commands, which may or may not work perfectly; if not, you may consider avoiding the apacite package and using the citation commands from the template instead."
        },
        "file_not_found": {
            "message": "Could not find a file to \\input{}",
            "severity": "high",
            "help": "Check file paths, especially relative file paths. HTML conversion assumes \\input{} paths are relative to the primary LaTeX source file (e.g., main.tex), whereas the LaTeX compiler can be slightly more generous by also allowing paths relative to the working directory. HTML conversion does not have access to the same working directory information, however."
        },
        "template_not_detected": {
            "message": "Could not determine whether this was an EDM or JEDM paper",
            "severity": "high",
            "help": "Make sure the paper uses the appropriate styles from the template. For a LaTeX paper either \"jedm.cls\" or \"edm_article.cls\" is expected in the root of the paper zip file. For a Word paper, the title is expected to use the appropriate style from the template (i.e., Paper-Title or MainTitle)."
        },
        "file_hash_edm_article.cls": {
            "message": "edm_article.cls did not match expected SHA256 hash",
            "severity": "medium",
            "help": "Please make sure you are using the correct version of the template, which may have been updated. Conversion may not work correctly with an outdated style file, especially for newer requirements like alt text for figures."
        },
        "bib_compile_errors": {
            "message": "Bibliography compilation errors (see log)",
            "severity": "medium",
            "help": "This type of error can be caused by various problems like repeated entries or missing expected entries in the bibliography file. The bibliography log toward the end of the conversion output should have more information to help you fix these issues. Warnings like \"empty journal\" usually do not stop compilation, though they might be worth examining anyway; other types of errors often do prevent compilation."
        },
        "style_paper_title": {
            "message": "Did not find \"Paper-Title\" style",
            "severity": "high",
            "help": "Select the text of your paper title in Word, open the Styles pane, and make sure that the \"Paper-Title\" style is used.",
            "tex": {
                "message": "Could not parse paper title",
                "help": "This error is unlikely to occur and may indicate a large problem. Check that the \\maketitle command was used in LaTeX, and that the template is correct."
            }
        },
        "style_long_heading": {
            "message": "Very long heading",
            "severity": "low",
            "help": "A heading has unusually long length. If this text was not intended as a heading, change the style to the appropriate style. To do so, select the heading text in Word, open the styles pane, and verify that the correct style is applied (\"Normal\" is often a good choice).",
            "tex": {
                "help": "A heading has unusually long length. Please double check that this is intended, and that it looks correct in the converted document."
            }
        },
        "style_abstract_heading": {
            "message": "Could not find abstract heading",
            "severity": "high",
            "help": "Select the text of the \"Abstract\" heading in Word, open the Styles pane, and make sure that the \"Abstract Heading\" style is used.",
            "tex": {
                "help": "Check that the paper has an abstract defined with the \\begin{abstract} and \\end{abstract} environment, as shown in the template."
            }
        },
        "style_keywords_heading": {
            "message": "Could not find keywords heading",
            "severity": "high",
            "help": "For EDM, make sure the paper has a \"Keywords\" heading, as shown in the template. Select the text of the \"Keywords\" heading in Word, open the Styles pane, and make sure the \"Keywords Heading\" style is used. For JEDM, make sure the Keywords are within the abstract with the \"Abstract\" style.",
            "tex": {
                "help": "Make sure the paper has keywords defined with the \\keywords{} command, as shown in the template."
            }
        },
        "style_keywords": {
            "message": "Could not find keywords",
            "severity": "high",
            "help": "For EDM, select the text of the keywords section in your paper in Word, open the Styles pane, and make sure the \"Keywords\" style is used. For JEDM, make sure the keywords are within the abstract block (not after) as in the template.",
            "tex": {
                "help": "Make sure the paper has keywords defined with the \\keywords{} command, as shown in the template."
            }
        },
        "style_author": {
            "message": "Could not find any authors",
            "severity": "high",
            "help": "Select the text of the first author's name, open the Styles pane, and make sure the \"Author\" style is used. Repeat for each author.",
            "tex": {
                "help": "Make sure authors are defined as shown in the template."
            }
        },
        "style_affiliations": {
            "message": "Could not find any affiliations",
            "severity": "medium",
            "help": "Select the text of the first author's affiliation, open the Styles pane, and make sure the \"Affiliations\" style is used. Repeat for each author.",
            "tex": {
                "help": "Make sure author affiliations are defined with the \\affaddr command as shown in the template."
            }
        },
        "style_email": {
            "message": "Could not find any e-mail addresses",
            "severity": "medium",
            "help": "Select the text of the first author's e-mail address, open the Styles pane, and make sure the \"E-Mail\" style is used. Repeat for each author.",
            "tex": {
                "help": "Make sure author e-mail addresses are defined with the \\email command as shown in the template."
            }
        },
        "style_email_in_author": {
            "message": "Author name contains \"@\" symbol",
            "severity": "medium",
            "help": "Text marked with the \"Author\" style contained an \"@\" symbol, suggesting it might contain an email address. Select each email address, open the Styles pane, and make sure it has the \"E-Mail\" style rather than \"Author\" style. Note that if you may need to add a paragraph break (i.e., press Enter) after each email address; otherwise, Word might force each email address to have the same style as the subsequent author's name does (in which case one of them will have the wrong style)."
        },
        "style_space_in_email": {
            "message": "Email address contains a space",
            "severity": "medium",
            "help": "Text marked with the \"E-Mail\" style contained a space, suggesting it might include some other text, such as author names. Open the Styles pane, select each part of the author info, make sure each part has the correct style. Note that if you may need to add a paragraph break (i.e., press Enter) after each email address; otherwise, Word might force each email address to have the same style as the subsequent author's name does (in which case one of them will have the wrong style). If this warning occurs because you are using some custom formatting of emails (e.g., \"[person1, person2] @ domain.com\") you may ignore it.",
            "tex": {
                "help": "Check to make sure the \\email command is used for email addresses only. If this warning occurs because you are using some custom formatting of emails (e.g., \"[person1, person2] @ domain.com\") you may ignore it."
            }
        },
        "style_no_intro": {
            "message": "No \"Introduction\" section found",
            "severity": "low",
            "help": "If you intended not to have an introduction section, ignore this message. Otherwise, select your Introduction heading in Word, open the Styles pane, and make sure the \"Heading 1\" style is used.",
            "tex": {
                "help": "If you intended not to have an introduction section, ignore this message. Otherwise, make sure you used the \\section{Introduction} command in your paper."
            }
        },
        "style_no_refs": {
            "message": "No \"References\" section found",
            "severity": "medium",
            "help": "Click on your References heading in Word, open the Styles pane, and make sure the \"Heading 1\" style is used.",
            "tex": {
                "help": "Make sure you used the \\bibliographystyle{abbrv} and \\bibliography{sigproc} (or whatever your .bib file is named instead of sigproc.bib) commands in your paper."
            }
        },
        "no_references_found_in_reference_section": {
            "message": "No reference section with references found",
            "severity": "medium",
            "help": "Check that your reference section is called 'REFERENCES' and uses the correct style.",
            "tex": {
                "help": "Make sure you used the appropriate section command and bibtex style."
            }
        },
        "no_citations_found_in_text": {
            "message": "No citations found in the text",
            "severity": "medium",
            "help": "Check that your in-text citations use the correct numbered style, e.g. [1].",
            "tex": {
                "help": "Make sure you used the appropriate \\cite command and square brackets citation style."
            }
        },
        "mismatched_refs": {
            "message": "Mismatched references",
            "severity": "low",
            "help": "The in-text citation numbers do not match your numbered references, indicating that there might be unused references in your References section, or citations to missing references. Make sure you are using square brackets citation style if you are not already.",
            "tex": {
                "help": "Make sure you used the appropriate \\cite command and square brackets citation style. If you already did that, this message may be a false positive, but please double check the citation numbers noted here to be sure."
            }
        },
        "incomplete_reference": {
            "message": "An entry in the reference section might be incomplete",
            "severity": "low",
            "help": "Find the numbered entry in your reference section and check for the missing elements. If we did not correctly recognize the entry's type, the warning may be invalid, but please double check these anyway.",
            "tex": {
                "help": "Check that the missing elements are in your Bibtex. If you see them but they don't appear in the PDF, you may have them in the wrong Bibtex field. If we did not correctly recognize the entry's type, the warning may be invalid, but please double check these anyway."
            }
        },
        "broken_internal_ref": {
            "message": "Broken internal cross-reference",
            "severity": "medium",
            "help": "Look for \"Error!\" in your document and fix the broken internal cross-reference. You may need to open the print dialog in Word (then simply close it without printing) to force internal cross-references to refresh.",
            "tex": {
                "help": "Search for \"??\" in the converted document to see where the error occurs. The most common cause is equations, which need to use <code>\\eqref</code> from the <code>amsmath</code> package so that they can be handled separately from regular <code>\\ref</code> references to tables, figures, and sections. Additionally, labels are case-sensitive (which some LaTeX compilers ignore), which is something to check."
            }
        },
        "wingdings": {
            "message": "Wingdings should not be used",
            "severity": "medium",
            "help": "Wingdings is not a good choice for typographical symbols because it is semantically meaningless. For example, a Wingdings right arrow is really the \"à\" character, which might hinder interpretation by people using screen readers or who do not have Wingdings installed. In most cases there is a <a href=\"https://unicode.org/charts/\">suitable Unicode symbol</a>, which can be pasted as plain text into your document."
        },
        "url_schema": {
            "message": "Missing or unexpected URI/URL schema",
            "severity": "low",
            "help": "If a link is missing the URI schema (e.g., \"https://\") it may not work. For example, a link to \"example.com\" without \"https//\" may link to a non-existent \"file:///example.com\" on some PDF viewers and browsers."
        },
        "quote_direction": {
            "message": "Unexpected curved quotation mark direction",
            "severity": "low",
            "help": "In English, curved quotation marks should be concave toward the word or phrase they are quoting, <span style='font-family: serif;'>&ldquo;like this&rdquo; but <strong>not</strong> &rdquo;like this&rdquo; nor &ldquo;like this.&ldquo;</span>"
        },
        "alt_text_missing": {
            "message": "Missing alt text for image",
            "severity": "high",
            "help": "Follow the instructions in the template for adding alt text to images. Every image needs alt text to ensure the paper can be understood by people using screen reader software. Additionally, alt text is used by the HTML conversion program to identify each image, so alt text must be unique for each image; things like image sizes may be wrong otherwise.",
            "tex": {
                "help": "Use the \\Description{} command, as shown in the template, to add alt text. Every image needs alt text to ensure the paper can be understood by people using screen reader software."
            }
        },
        "alt_text_long": {
            "message": "Alt text may be too long (over 2000 characters)",
            "severity": "low",
            "help": "Alt text should be succinct to provide the best experience to people using screen reader software, since some screen readers may stop reading the text if it is too long."
        },
        "alt_text_duplicate": {
            "message": "Duplicate alt text for image",
            "severity": "high",
            "help": "Alt text should be unique per image, so that someone using screen reader software can understand the unique contents of each image. Even if the images are duplicates, the alt text should be unique to explain which image is a duplicate and why. Additionally, the HTML converter uses alt text as a unique identifier to find size and cropping information about images, so without unique alt text the images may be displayed incorrectly.",
            "tex": {
                "help": "Alt text should be unique per image, so that someone using screen reader software can understand the unique contents of each image. Even if the images are duplicates, the alt text should be unique to explain which image is a duplicate and why."
            }
        },
        "alt_text_ai_generated": {
            "message": "Alt text appears to be AI-generated",
            "severity": "high",
            "help": "The built-in alt text generator in Word is currently not nearly good enough to provide a reasonable substitute for human-written alt text."
        },
        "jedm_figure_filename": {
            "message": "Image filename issue for JEDM",
            "severity": "high",
            "help": "The JEDM journal system will sometimes return 404 for images with \"+\" or \" \" (space) in the filename for some reason. These files should be renamed."
        },
        "tex_file_missing": {
            "message": "No .tex files found in root of .zip file; cannot process",
            "severity": "high",
            "help": "The most likely cause of this problem is if your LaTeX source file is in a folder inside the .zip file. To fix this, create a .zip file by selecting all the files in your project and compressing them, rather than compressing the containing folder."
        },
        "ambiguous_tex_file": {
            "message": "Multiple .tex files found and none named \"main.tex\"; unclear which to use",
            "severity": "low",
            "help": "The converter will try a few common names, then use the lexicographically first .tex file in your .zip file if it is unclear which to use. If that is not the correct file, fix this by renaming the primary file to compile to \"main.tex\"."
        },
        "author_data_missing": {
            "message": "Could not find author metadata section",
            "severity": "high",
            "help": "Make sure to specify author information, include names, affiliations, and e-mail addresses, as shown in the template."
        },
        "table_caption_missing": {
            "message": "No table caption starting with \"Table\" found",
            "severity": "medium",
            "help": "Select the text of each of your table captions in Word, open the Styles pane, and make sure the \"Caption\" style is selected.\nNote that \"table index\" refers to counting tables in the order they seem to appear in the document source, which may not be exactly the same order they are laid out on the page. Check all table captions to be on the safe side."
        },
        "table_header_missing": {
            "message": "No table header row(s) found",
            "severity": "medium",
            "help": "Select the cells of the header row(s) in each of your tables, right click, and click on \"Table Properties\". Then check the box \"Repeat as header row at the top of each page\", which will mark the row as a header (regardless of whether the table spans multiple pages).\nNote that \"table index\" refers to counting tables in the order they seem to appear in the document source, which may not be exactly the same order they are laid out on the page. Check all table headers to be on the safe side."
        },
        "table_no_data": {
            "message": "Table has no contents detected",
            "severity": "medium",
            "help": "No table data was detected in the table. This may occur if the entire table is marked as header rows via the \"Repeat as header row at the top of each page\" option in Word. Only the header row(s) should have this option if so. Alternatively, this may occur if the entire table text is written in bold."
        },
        "table_styles_missing": {
            "message": "Possible missing \"Table Header\" or \"Table Text\" styles",
            "severity": "medium",
            "help": "First check the header row(s) of your tables by selecting the header cells, opening the Styles pane, and verifying that the \"Table Header\" style is used. Then repeat for the content cells of your tables, checking for the \"Table Text\" style.\nThis warning may occasionally occur even if the correct styles are applied, if the contents of the table are more complicated than typical text; if so, ignore this warning unless the converted document looks incorrect.\nNote that \"table index\" refers to counting tables in the order they seem to appear in the document source, which may not be exactly the same order they are laid out on the page. Check all tables to be on the safe side."
        },
        "wmf_images": {
            "message": "Document contains WMF images, which are not fully supported",
            "severity": "medium",
            "help": "Size and alt text will have to be manually added after conversion. Please notify pnb@illinois.edu and CC pnigelb@gmail.com."
        },
        "emf_conversion_failed": {
            "message": "EMF image conversion failed",
            "severity": "high",
            "help": "An EMF image was not able to be converted to PNG. This means your paper will probably be missing a figure, which is bad. Some new versions of Word embed EMF images that cannot yet be converted, so these have to be manually handled. Please notify pnb@illinois.edu and CC pnigelb@gmail.com."
        },
        "missing_image": {
            "message": "Missing image file",
            "severity": "high",
            "help": "An image file was not found in the converted document. This is likely due to an image conversion failure."
        },
        "unknown_image_type": {
            "message": "Unexpected image format",
            "severity": "medium",
            "help": "The image may have to be converted to a web-compatible format after document conversion. Please notify pnb@illinois.edu and CC pnigelb@gmail.com."
        },
        "unknown_caption_type": {
            "message": "Unknown caption type",
            "severity": "medium",
            "help": "This warning occurs if the parser could not determine whether a caption belonged to a table or figure based on the text of the caption. Figure captions should start with \"Figure X\" or \"Fig. X\", while table captions should start with \"Table X\". Using the Insert Caption functionality in Word when creating captions should ensure this is the case."
        },
        "caption_in_table": {
            "message": "Caption inside table row",
            "severity": "medium",
            "help": "Captions should usually not be inside tables, with rare exceptions for tables of many small figures (e.g., a grid of icons with subcaptions). Though it may look the same visually in the original document, semantically it does not make sense for the caption to be treated as tabular data. Hence, it will be odd for someone reading the paper using a screen reader, or when converted to HTML."
        },
        "no_caption_number_period": {
            "message": "Incorrect or missing punctuation after caption number",
            "severity": "medium",
            "help": "For EDM, captions should have a period after the caption number, like \"Figure 1. Some caption here\"; for JEDM, it should be a colon, like \"Figure 1: ...\"."
        },
        "table_caption_distance": {
            "message": "Table not found immediately below caption",
            "severity": "medium",
            "help": "Table captions should appear directly above tables with nothing between them and the table.",
            "tex": {
                "help": "The \\caption command should appear before your table content so that the caption is above the table. Check the template to see an example."
            }
        },
        "image_as_table": {
            "message": "Image found below table caption",
            "severity": "medium",
            "help": "There is an image directly below a table caption, where a table is expected. If this is an image or screenshot of a table, it should be converted to a real table. An image of a table will not be readable by people using screen reader software, nor by automated tools (e.g., search engines)."
        },
        "figure_caption_distance": {
            "message": "Figure not found immediately before caption",
            "severity": "medium",
            "help": "Figure captions should appear directly below figure images with nothing between them and the figure image."
        },
        "figure_caption_unstyled": {
            "message": "Figure caption may be missing style",
            "severity": "medium",
            "help": "Figure captions should have the \"Caption\" style, as shown in the template. Given that one of the images in the document was immediately followed by \"Figure...\" text, it seems like it may have been intended to be a caption. Using the \"Caption\" style is essential to denote where the caption starts and ends, and whether the image is a figure or an image with some other purpose."
        },
        "figure_caption_blank": {
            "message": "Blank figure caption",
            "severity": "medium",
            "help": "This often happens if something that is not a caption has the \"Caption\" style, such as a blank paragraph (newline) or an image. The message above should show approximately where in the document it occurred. One way to find these cases is to open the Styles pane in Word, click on the down arrow by the \"Caption\" style, and click \"Select All\". After selecting the part that should not be a caption, set the appropriate style (\"Normal\" is often a good choice). This warning is often accompanied by an unknown caption type warning, which might be fixed by fixing this."
        },
        "chart_caption_not_found": {
            "message": "Chart caption not found",
            "severity": "medium",
            "help": "A \"chart\" is a DrawingML object, such as a graph pasted in from Excel. This warning indicates that the caption could not be found for a chart. Chart captions are just like figure captions, and should start with \"Figure X\" or \"Fig. X\". Chart parsing can be finicky, so please contact support if you believe this warning is incorrect."
        },
        "chart_caption_distance": {
            "message": "Chart caption not found immediately after chart",
            "severity": "medium",
            "help": "A \"chart\" is a DrawingML object, such as a graph pasted in from Excel. The chart caption should appear directly below the chart with nothing between the caption and chart. Chart captions are just like figure captions, and should start with \"Figure X\" or \"Fig. X\". Chart parsing can be finicky, so please contact support if you believe this warning is incorrect."
        },
        "tex_env_parse_fail": {
            "message": "LaTeX environment parsing error",
            "severity": "medium",
            "help": "The LaTeX parser was unable to find the environment containing a specific line. This indicates a possible mismatch in \\begin{} and \\end{} statements in your LaTeX source, or a possible bug in the parser (in which case please contact support)."
        },
        "no_newline_after_algorithmic": {
            "message": "Blank line suggested",
            "severity": "low",
            "help": "It is occasionally helpful to add a blank line after the \\end{algorithmic} command. For example, the LaTeX HTML compiler will sometimes render inline math as block equations (each on its own line) if this blank line is missing. If the result looks OK, you may safely ignore this message."
        },
        "tex_subfile_implementation": {
            "message": "\\subfile command not fully supported",
            "severity": "low",
            "help": "The \\subfile command is treated just like \\input during conversion. If you are using \\subfile like \\input to include a portion of a document, that should work. Otherwise, if the subfile is a complete standalone document, it is unlikely to work."
        }
    }
}