Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Description of HTML5 parameters is not equal to the HTML-based output parameter description #132

Closed
stefan-jung opened this issue Feb 26, 2017 · 1 comment
Assignees
Labels
bug Something isn't working refactoring Changes to organization of docs source
Milestone

Comments

@stefan-jung
Copy link
Contributor

The following parameters are explained on HTML-based output parameters and also on HTML5 parameters.

  • args.artlbl
  • args.copycss
  • args.css
  • args.csspath
  • args.cssroot
  • args.dita.locale
  • args.ftr
  • args.gen.default.meta
  • args.hdf
  • args.hdr
  • args.hide.parent.link
  • args.indexshow
  • args.outext
  • args.xsl

If possible, the descriptions should be equal/reused or simply removed from the HTML5 page, because they are not specific to HTML5. For example, compare the args.hdf description. If you like, explain how you want this to be handled and I'd send a PR.

@infotexture infotexture added bug Something isn't working refactoring Changes to organization of docs source labels Feb 26, 2017
@infotexture
Copy link
Member

This is a side-effect of the de-coupling of the HTML5 plug-in for version 2.4. As the Release Notes say:

In release 2.4, all dependencies between HTML5 and XHTML have been removed to ensure that HTML5 processing can be further refactored in the future without affecting XHTML output, or other HTML-based transformations such as eclipsehelp, htmlhelp or javahelp.

Whereas in 2.3, the listings for HTML5 and XHTML parameters and HTML5 contained only specific parameters (not shared with with the base HTML transform), the new HTML5 architecture actually duplicates these parameters.

The conref push mechanism is used to extend the descriptions in the base HTML parameter listing, but since the augmented descriptions are only pushed to a single location, the duplicates in the HTML5 topic do not currently benefit from the editorial improvements.

The re-use mechanism should be re-evaluated to either push the extended descriptions to the HTML5 topic too, or exclude the duplicate parameters from the autogenerated listing for HTML5.

@infotexture infotexture added this to the 2.5 milestone May 18, 2017
@infotexture infotexture self-assigned this May 18, 2017
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working refactoring Changes to organization of docs source
Projects
None yet
Development

No branches or pull requests

2 participants