Module word_processing

Creates a document dict which contains the XML files from a document file by the given fileExtension.

Parameters:

• fileExtension - can be docx or odt or odp etc.

Returns:

The document dictionary.

Processes requirements by looping through checkers dict which contains the method names described in the XML requirement file.

Parameters:

• inspector - defines the given inspector.
• document - defines document dictionary which contains the XML files.
• requirements - defines Requirements object which contains the given requirements in the XML requirement file.
• results - defines the given errors in the results dictionary.

Checks the boolean requirements. The inspector methods return a boolean.

Returns:

True if expectedValue is returned from the inspector method, False otherwise.

Checks the dictionary requirement. The inspector methods return a dictionary of which the values are compared to the ones in XML requirement file.

Checks the requirement sections. The inspector method takes an empty list as an argument. If its length is not zero after the inspector method, it means that errors were founded.

Returns:

out from the method if inspectorData return False.

Checks the requirement margins by calling the checkDictRequirement.

Checks the heading numbering requirement.

Error ids and positions are defined in a dict which is then used in the method inspector.checkHeadingNumbering(document, errorIdsAndPositions). If the keys in the dict are not None, errors have been appended.

Checks the style requirements. Compares the style requirements described in the XML file to the document properties defined by the user. Appends a default error if inspector.getStyle returns False.

Returns:

Nothing if inspector.getStyle returns False.

Checks if the table of the contents exists. If it does not exist, appends a default error message.

If it exists, checks if the table of contents is correctly made. If not, append an error message.

Checks if there are images in the document. Calls the checkBooleanRequirement function.

Checks empty paragraphs from the document. Appends an error message if there are some to be found.

Checks if there are lists in the document. Calls the checkBooleanRequirement function.

Checks the style usage. An error dict (below) with two key-value pairs is used in the method inspector.checkStyleUsage. The inspector method returns the text paragraphs where manual changes have been made or style has not been used at all.

errorIdsAndPositions = {'styleNotUsed': [], 'manualChanges': []}

Checks if the tabs have been used in the document. Does nothing if tabs are not found, otherwise append an error message.

Checks if double whitespaces are found in the document. Does nothing if double whitespaces are not found, otherwise append an error message.

Checks if asterisks are found in the document. Does nothing if asterisks are not found, otherwise append an error. A special print formatting is used here. Could be useful in other methods as well.

Checks if image captions are used.

Checks the headers and the footers requirement.

The method can be run only if checkRequirementSections goes through. The function is hard to implement in a smart way.

Checks if index is found in the document. If index is correctly made, checks the index content.

Inspects a document by the given file extension which is either odt or docx.

Parameters:

• documentFile - docx or odt file.
• requirements - the requirements specified in the XML requirement file.
• fileExtension - docx or odt file.

inspectorDict

Value:

{'docm': <module 'src.inspectors.docx_inspector' from '/home/olkauppi/ Desktop/parsi-project-parsi/parsi-project-parsi/src/inspectors/docx_in spector.pyc'>, 'docx': <module 'src.inspectors.docx_inspector' from '/home/olkauppi/ Desktop/parsi-project-parsi/parsi-project-parsi/src/inspectors/docx_in spector.pyc'>, 'odt': <module 'src.inspectors.odt_inspector' from '/home/olkauppi/De sktop/parsi-project-parsi/parsi-project-parsi/src/inspectors/odt_inspe ...