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

Cleanup file hierarchy listings #3011

Merged
merged 4 commits into from
Oct 21, 2021

Conversation

henrikt-ma
Copy link
Collaborator

Initiating in Draft state, as I also need to check for more listings that should use the new language.

Copy link
Member

@beutlich beutlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that, even it is mono-space in TeX source it is not in the rendered HTML, which is especially apparent for the indented comment.

grafik

@beutlich beutlich linked an issue Oct 5, 2021 that may be closed by this pull request
@henrikt-ma
Copy link
Collaborator Author

Note that, even it is mono-space in TeX source it is not in the rendered HTML, which is especially apparent for the indented comment.

Yes, I noted that too, but couldn't think of a quick fix for this. I'm noting that our filenames don't look quite right in the PDF either, with the variable-width glyphs being placed on a grid. Let's see if we can fix it as part of this PR. I can make an attempt with the tabbing environment instead, and see how that goes with LaTeXML. Any other ideas?

@beutlich
Copy link
Member

beutlich commented Oct 6, 2021

Any other ideas?

TeXExchange says dirtree is my friend: https://tex.stackexchange.com/questions/5073/making-a-simple-directory-tree

@henrikt-ma
Copy link
Collaborator Author

TeXExchange says dirtree is my friend: https://tex.stackexchange.com/questions/5073/making-a-simple-directory-tree

Looks very pretty, but I see no signs of it being supported by LaTeXML.

@dietmarw
Copy link
Member

dietmarw commented Oct 6, 2021

@henrikt-ma Have you already tried it in combination with LaTeXML?

@henrikt-ma
Copy link
Collaborator Author

henrikt-ma commented Oct 6, 2021

Apart from a LaTeXML glitch (would it even be worth reporting, considering that it's hard to imagine how it could be handled in HTML with stylesheets applied after the build?), the result with a tabbing environment doesn't look too bad to me:
tabbing-html

The pdfLaTeX output shows my intention:
tabbing-pdf

@beutlich
Copy link
Member

beutlich commented Oct 6, 2021

From the very same TeXExchange reference: forest package can also do it in a nice way.

@henrikt-ma
Copy link
Collaborator Author

From the very same TeXExchange reference: forest package can also do it in a nice way.

But did you see any sign of it being supported by LaTeXML?

@sjoelund
Copy link
Member

sjoelund commented Oct 6, 2021

From the very same TeXExchange reference: forest package can also do it in a nice way.

But did you see any sign of it being supported by LaTeXML?

Some packages work without any intervention, right? But the most problematic parts are things like verbatim text, which I assume this is... Might be good to try

@henrikt-ma
Copy link
Collaborator Author

@henrikt-ma Have you already tried it in combination with LaTeXML?

No, and as @sjoelund suggests, it seems to be worth a try even though I didn't find any signs of support when searching the web.

@henrikt-ma
Copy link
Collaborator Author

OK, after verifying that the PDF looks as expected with dirtree.sty, this is how it fails with LaTeXML:

Warning:missing_file:dirtree Can't find binding for package dirtree
	at mini.tex; line 3 col 6 - line 3 col 6
	Anticipate undefined macros or environments
	search paths are /Users/henrikt/Documents/minimal-LaTeXML
	In Core::Definition::Constructor[\usepac... /opt/local/lib/perl5/vendor_perl/5.28/LaTeXML/Package/LaTeX.pool.ltxml; line 798

Error:undefined:\dirtree The token T_CS[\dirtree] is not defined.
	at mini.tex; line 4 col 8 - line 4 col 8
	Defining it now as <ltx:ERROR/>
	Next token is T_BEGIN[{]
	In Core::Gullet[@0x7faf9901d500] /Users/henrikt/Documents/minimal-LaTeXML/mini.tex; from line 4 col 9 to line 4 col 9
	 <= Core::Stomach[@0x7faf9901cdb0] <= ...
 4.38 sec) 4.85 sec)

Considering that forest.sty provides a PGF/TikZ-based mechanism for drawing, is it even interesting for us?

@HansOlsson
Copy link
Collaborator

Apart from a LaTeXML glitch (would it even be worth reporting, considering that it's hard to imagine how it could be handled in HTML with stylesheets applied after the build?), the result with a tabbing environment doesn't look too bad to me: tabbing-html

Apart from two lines it looks good. Would it be possible to change them to avoid it?

@henrikt-ma henrikt-ma force-pushed the cleanup/file-hierarchy-listing branch from 035857b to 693bb8f Compare October 20, 2021 12:29
@henrikt-ma
Copy link
Collaborator Author

Apart from two lines it looks good. Would it be possible to change them to avoid it?

Yes. Done.

@henrikt-ma
Copy link
Collaborator Author

Removing Draft state as I couldn't find any other file hierarchy listings to clean up.

@henrikt-ma henrikt-ma marked this pull request as ready for review October 20, 2021 12:44
Copy link
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good now.

@HansOlsson HansOlsson merged commit 8632a39 into modelica:master Oct 21, 2021
@henrikt-ma henrikt-ma deleted the cleanup/file-hierarchy-listing branch October 21, 2021 21:21
@HansOlsson HansOlsson added the M36 For pull requests merged into Modelica 3.6 label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
M36 For pull requests merged into Modelica 3.6
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Undesired Modelica syntax hightlighting for file name
5 participants