-
Notifications
You must be signed in to change notification settings - Fork 7
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
Add hyperref links for MPI symbols throughout the standard #826
Comments
Some changes to the workflow maybe needed to generate an HTML version. |
I had seen this HTML version we're hosting but didn't realize that it's MPI 2.2. We should probably update that. https://www.mpi-forum.org/docs/mpi-2.2/mpi22-report/mpi22-report.htm |
There are more recent HTML versions - see the docs page. They aren't perfect; there might be a tool that can better handle the LaTeX in the standard now, but there wasn't the last time I checked (which was probably > 10 years ago). |
Ahh that's right. Somehow Google gave me links to the 2.2 version. I tried to build the html version of the standard ( @bkmgit What changes do you think would be needed? |
Ahh that's right. Somehow Google gave me links to the 2.2 version. I
tried to build the html version of the standard (|make HTMLVERSION|) but
I'm missing |tohtml| and cannot figure out what package that belongs to.
Clearly not on Arch:
https://man.archlinux.org/man/tohtml.1.en
@bkmgit <https://github.com/bkmgit> What changes do you think would be
needed?
Gemini support. For html, dark mode.
|
tohtml is part of a very old package of tools I used to automate some elements of package development. I'm in the midst of enhancing tohtml to address some of the shortcomings in the 4.1 version. |
If a license (preferably one that is well known and used for other free
and open source HPC software) could be added, that would really help
inclusion in other linux distributions. Can add dark mode support. Maybe
easier to create a separate derivative package togemini, can do this,
but not the highest priority.
|
Can you point me at an example of what it should look like? Normally, text is copyrighted, not licensed, though I can see there's a grey area with HTML. Dark mode is non-trivial, because some more complex LaTeX is currently handled by generating an image directly from the LaTeX, then including that image. But I can also look into this (tohtml dates from long before CSS, and so has a very old-fashioned HTML output). |
License is for the sowing package. Made a pull request to add MPICH license: For the standard, probably SPI would hold rights but some agreement would be needed. |
Created separate issue for document and code licensing #827 |
Problem
It is hard to navigate through the standard because both the PDF and HTML versions are lacking hyperlinks. By adding hyperlinks to both versions users can jump to the definition of a symbol (function, datatype, error handler) without having to use the document search function.
Proposal
Extend the corresponding LaTeX macros to add a
\hypertarget
to\*main
macros and link to it in the non-main macros (except for skip macros).Changes to the Text
No changes to the text, except for the cleanup of erroneous macro usage in #825. All other changes are solely in the user-facing macros.
Impact on Implementations
None
Impact on Users
Hyperlinks make users happy.
References and Pull Requests
Initial draft of the hyperref integration: https://github.com/mpi-forum/mpi-standard/pull/954
The text was updated successfully, but these errors were encountered: