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

minor tweaks for doc page #36

Open
VladimirAlexiev opened this issue Dec 13, 2024 · 0 comments
Open

minor tweaks for doc page #36

VladimirAlexiev opened this issue Dec 13, 2024 · 0 comments

Comments

@VladimirAlexiev
Copy link

https://cim-compare.ucaiug.io/#option-1-enterprise-architect-eap-or-qea-baseline-and-destination-project-files-as-inputs and further sections:

Code blocks are rendered with long horizontal scrollbars because they are very long lines. Applies to:

java -jar cim-compare-1.3.0.jar ...
"C:\Program Files\Zulu\zulu-17\bin\java.exe" -mx4096m ...
"C:\Program Files (x86)\Zulu\zulu-17\bin\java.exe" ...
  • if the rendering cannot wrap the command line, then do it by hand, eg
java -jar cim-compare-1.3.0.jar <baseline-model-file> <destination-model-file> [<output-directory-or-html-file>] \
  [--package=<package-name>] [--minimal] [--include-diagrams] [--image-type=<image-file-extension>] [--zip]

The -- in options are rendered as long dashes – in all text except the code blocks.

  • If I search for --package in the page, it doesn't find the long description of that option:

[–package=<package-name>] (Optional): The root package ...

  • I cannot copy from Command Line Examples and paste them in the terminal
  • So please use backticks to escape code-like parts, eg:

[–package=<package-name>] (Optional): The root package ...

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

No branches or pull requests

1 participant