Flexible Word Generation

picklesdoc / pickles

The open source living documentation generator

http://www.picklesdoc.com/

Apache License 2.0

464 stars 164 forks source link

Flexible Word Generation #624

Closed SpocWeb closed 2 years ago

SpocWeb commented 2 years ago

To generate a less cluttered Word Document we added the Feature of removing Tags and Scenarios with the existing 'HideTags' Switch. Also configurable separating Features by Page using a new Switch 'FeaturesOnSamePage'

Command Line Parameters:

'HideTags' filters Scenarios and Tags in Word Documents
'FeaturesOnSamePage' does not separate Features into Word-Pages

ericcmmi commented 2 years ago

Hey @SpocWeb thanks for the contribution! Sorry I'm taking so long to reply. Code looks good. Are there some unit tests you could add or modify so we have coverage for the new features?

SpocWeb commented 2 years ago

Sorry, for now I just fixed the broken tests to run also on Windows (the Path-Separator of Uri is NOT dependent on the OS). I don't know when I'll have time to make up a functional test and there is none that I can adapt, as far as I can see.

We are not actually using pickles anymore, because of the missing Markdown Formatting. We are generating MarkDown Files directly and have them transformed to HTML and Word later.

ericcmmi commented 2 years ago

Thanks @SpocWeb! Merged your changes. Does the current MarkDown formatting not work for you? Let me know what is missing.

SpocWeb commented 2 years ago

Thanks for accepting my Change. The current MarkDown in Word does not support Links, Images or Inline Formatting like Bold or Italic. I don't quite remember if it supported proper Tables. We want to use the full MD with Bullets, multiple Levels etc. so it was easier for us to just output the Markdown from the Test-Json into a new Markdown File.