Project

General

Profile

Bug #1180

Online manual formatting broken

Added by Justin Lemkul over 6 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
documentation
Target version:
Affected version - extra info:
Affected version:
Difficulty:
uncategorized
Close

Description

Text enclosed within <!--QuietIdx--> <!--EQuietIdx--> blocks messes up the online manual, specifically noted in mdp_opt.html. These blocks lead to text duplication throughout the page. The delimiters can be easily deleted, but I don't know what their purpose is.

Associated revisions

Revision 0f6eb56a (diff)
Added by Mark Abraham over 4 years ago

Add mdp-options to user guide

Formating changes to create hyperlink targets and index entries using
custom reStructuredText directives. There are likely many
opportunities for cross-references that are not yet implemented.

With some extra effort (not using the convenient add_object_type()), it
should also be possible to remove the integrator= part from references
to mdp values and add customized index entries for them, but with the
current directive and role syntax, that can be done independently from
writing the documentation.

Fixes #1180

Change-Id: Id43cdbe9d3c2faab76fb12ac07abfd88a688dcd6

History

#1 Updated by Mark Abraham over 6 years ago

  • Status changed from New to Accepted
  • Target version changed from 4.6.2 to 4.6.3
  • Affected version set to 4.6

In the cavernous depths of time, there was only Idx, which was used to make LaTeX manual index entries, and silently passed those through to the HTML version. But sometimes the text doesn't match what the index entry should be, so I added QuietIdx. This is correctly processed for LaTeX, and I never thought about what the HTML would do with it. Answer: the unknown tag is ignored.

#2 Updated by Mark Abraham over 6 years ago

  • Status changed from Accepted to In Progress

I think this can be fixed in admin/mkhtml with sed. I will work on that fix as I release 4.6.2, and upload the fix after that

#3 Updated by Mark Abraham over 6 years ago

  • Target version changed from 4.6.3 to 4.6.x

#4 Updated by Mark Abraham about 6 years ago

  • Status changed from In Progress to Accepted
  • Priority changed from Normal to Low
  • Target version changed from 4.6.x to future

My release script has a hack that works around this. We can fix it properly some time when we have a chance to overhaul the documentation.

#5 Updated by Rossen Apostolov over 5 years ago

  • Project changed from GROMACS to Documentation
  • Category deleted (documentation)

Moving the issue to "Documentation" sub-project.

Shall we remove the "documentation" category in "Gromacs" or alternatively, remove the "Documentation" sub-project? It seems redundant with both.

#6 Updated by Mark Abraham over 5 years ago

I think the project should go. Documentation is integral, not an afterthought.

#7 Updated by Rossen Apostolov over 5 years ago

  • Project changed from Documentation to GROMACS
  • Category set to documentation

the good thing about having it as a separate project is that it's easier to see if somebody wants to contribute specifically to the documentation. But there hasn't been a stampede of contributors :) I'll move then the issues as categories and remove the sub-project

#8 Updated by Rossen Apostolov over 5 years ago

The "Documentation" sub-project has a number of different categories such as manual, in-source, website etc. But since eventually the documentation will be more and more centrally maintained, any objection to remove those categories too?

#9 Updated by Mark Abraham over 5 years ago

Seems fine to remove sub-projects.

#10 Updated by Mark Abraham almost 5 years ago

  • Status changed from Accepted to Resolved
  • Target version changed from future to 5.1

The new user guide uses markdown, so this will be fixed there.

#11 Updated by Gerrit Code Review Bot almost 5 years ago

Gerrit received a related patchset '1' for Issue #1180.
Uploader: Mark Abraham ()
Change-Id: Id43cdbe9d3c2faab76fb12ac07abfd88a688dcd6
Gerrit URL: https://gerrit.gromacs.org/4435

#12 Updated by Mark Abraham over 4 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF