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

Document additional configuration properties #46

Closed
infotexture opened this issue Dec 9, 2015 · 3 comments
Closed

Document additional configuration properties #46

infotexture opened this issue Dec 9, 2015 · 3 comments
Labels
coverage Incomplete information in existing topics
Milestone

Comments

@infotexture
Copy link
Member

@georgebina reported:

The documentation for the configuration.properties file lists a few properties but from Configuration.java it looks like there are also entries like print_transtypes, plugin.[name].dir and parser.[format]=[value]

The existing topics in the Configuration properties section of the Parameter Reference should be updated to cover the missing properties, explain how properties files are used internally by the toolkit, and clarify the difference between configuration properties and argument properties that users can set at transformation time.

We should also consider extending this section to cover not only configuration properties, but also include information on how users can use property files to specify transformation parameters by passing a property file as an argument to the dita command:

dita -propertyfile file

Load all properties from a file. Properties specified with the -D option take precedence.

@infotexture infotexture added the coverage Incomplete information in existing topics label Dec 9, 2015
@jelovirt
Copy link
Member

jelovirt commented Dec 9, 2015

Note that configuration properties and argument parameters are not necessarily the same, i.e. some configuration properties cannot be set as arguments, and the -propertyfile argument does not override the configuration file properties.

@infotexture
Copy link
Member Author

Right, I think these are the sorts of things that should be clarified (which properties can be set where, which take precedence if the same ones are defined in different places, etc.).

@infotexture
Copy link
Member Author

NOTE: A tutorial on “Setting DITA-OT parameters with .properties files” is one of the proposals in #37.

@infotexture infotexture modified the milestone: 2.4.3 Jan 10, 2017
infotexture added a commit that referenced this issue Jan 27, 2017
Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit that referenced this issue Jan 28, 2017
Add related links:
* DITA 1.3 spec on metadata cascade
* @jelovirt’s “Font configuration in PDF2” post

Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit that referenced this issue Jan 28, 2017
* develop:
  Clarify .properties precedence cascade (Fixes #46)
  Escape backslashes in .properties (Fixes #102)
  Add topic on `local.properties` file (Fixes #81)
  Remove obsolete info, update PDF2 I18N for #46
  Document additional configuration properties #46
  Add spec links on metadata cascading
  Revise `plugin.properties` description
@infotexture infotexture moved this from In Progress / Up Next to Done in 2.4.3 Release Jan 28, 2017
infotexture added a commit that referenced this issue Jan 29, 2017
* hotfix/2.4.3: (28 commits)
  Implement review feedback on 2.4.3 Release Notes
  Add info on docs updates to 2.4.3 RN
  Add info on dita-ot/dita-ot#1525 to 2.4.3 RN
  Add info on dita-ot/dita-ot#2038 to 2.4.3 RN
  Add info on dita-ot/dita-ot#2522 to 2.4.3 RN
  Add info on dita-ot/dita-ot#2555 to 2.4.3 RN
  Add info on dita-ot/dita-ot#2563 to 2.4.3 RN
  Re-use `org.dita.pdf2.i18n.enabled` description
  Format & indent per project conventions
  Push extended description for PDF2 I18N
  Update index entries for configuration.properties
  Push extended description for `default.language`
  Clarify .properties precedence cascade (Fixes #46)
  Escape backslashes in .properties (Fixes #102)
  Add topic on `local.properties` file (Fixes #81)
  Remove obsolete info, update PDF2 I18N for #46
  Document additional configuration properties #46
  Add spec links on metadata cascading
  Revise `plugin.properties` description
  Add list of resolved issues to 2.4.3 Release Notes
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
coverage Incomplete information in existing topics
Projects
No open projects
Development

No branches or pull requests

2 participants