Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markout warnings/errors - genericize #84

Open
kphunter opened this issue Mar 13, 2020 · 1 comment · Fixed by #85
Open

markout warnings/errors - genericize #84

kphunter opened this issue Mar 13, 2020 · 1 comment · Fixed by #85

Comments

@kphunter
Copy link
Contributor

I'd like to start a conversation about Dewordify's output. I'd like to suggest that we reduce the Dewordify/Estimate console output and remove references to specific individuals (eg. ERROR! Search the output for class="heading2" and show it to Mike).

IMHO, the output would have 3 "sections", formatted in Markdown style, similar to:

## Errors
### Your Learning Journey... (page title)
**Missing Markers**

Marker | Count
------ | -----
#activity | X
/activity | X-1

Marker | Count
------ | -----
#review | X
/review | X-1

**Unknown markers**

Marker | Count
------ | -----
#admit ticket | X
/admit ticket | X

### Activity 4: Decision-making... (page title)
**Missing Markers**

Marker | Count
------ | -----
#reflection | X
/reflection | X-1

## Warnings
**Unrecognized elements**
  * Image of type image/x-emf is unlikely to display in web browsers... (for example)


## Info/Summary

Element | Count
------- | -----
Pages   | X
Media   | X
Discussions | X
Assignments | X
Quizzes/self-tests | X

where:

(Media = sum of #video markers, #audio markers, and #interaction markers)
(Discussions = sum of #discussion markers)
(Assignments = sum of #assignment markers)
(Quizzes/self-tests = sum of #quiz markers)

This probably means suppressing some of the current Mammoth.js warnings/errors...

I'd also suggest that the current output stats (# lists, #words per page, # learning blocks, etc...) are moved to a command that is called with a -v tag or something similar.

@kphunter
Copy link
Contributor Author

In helping Diane navigating estimating, we determined that there is still too much information being returned in the script output. A bit more work on this task would mean a more direct 1-to-1 relationship with the build time calculator.

This probably means suppressing some of the current Mammoth.js warnings/errors...

Ideally, a detailed output would still be available, but as a command line option rather than by default.

I would suggest removing these details from the default output:

  1. any warnings referring to Unknown Word Styles
  2. Pages word count details
  3. Image, Table, and List summary details
  4. All Learning Blocks counts other than those that can be summed and added to the "custom iframe embeds" calculator field
    • markers like #discussions, or #activities do not automatically translate into tasks to create discussions or assignment dropboxes in the LMS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant