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

Add topic on local.properties file #81

Closed
markgif opened this issue Feb 18, 2016 · 3 comments
Closed

Add topic on local.properties file #81

markgif opened this issue Feb 18, 2016 · 3 comments
Labels
coverage Incomplete information in existing topics
Milestone

Comments

@markgif
Copy link
Contributor

markgif commented Feb 18, 2016

I don't know if this applies to later OT versions but this works for 1.7.5 on Windows 7. A local.properties file is mentioned in the docs in reference to using the Antenna House PDF processor. Here is some fleshed out info that would be good in the docs.

I created a text file called local.properties and put it in the 1.7.5 OT root directory. The entire content of the file is this:

axf.path=C:\Program Files\Antenna House\AHFormatterV62

I had to escape the backslashes by repeating them: \

No quotes around the path were needed, even though there are spaces in it. Adding quotes around the path makes it fail.

It does not require that you run integrator to make it take effect.

Mark

@infotexture infotexture changed the title local.properties file with OT 1.7.5 Add topic on local.properties file Feb 18, 2016
@infotexture infotexture added the coverage Incomplete information in existing topics label Feb 18, 2016
@infotexture infotexture added this to the 2.3 milestone Feb 18, 2016
@infotexture
Copy link
Member

Thanks for the input. You're right, the docs are a bit sparse with regard to the use of .properties files.

We're working on improving this with the changes for #62, which adds info on “Setting build parameters with .properties files”, and #46, which points out missing configuration properties.

We'll add a new topic to explain how the local.properties file can be used, and how properties set there interact with those defined via dita -propertyfile and dita -Dparameter=value.

@markgif
Copy link
Contributor Author

markgif commented Feb 27, 2016

Thanks! I have since also found out about two undocumented command line parameters for enabling the use of Antenna House:

ahf.dir
The directory where AH is installed.

ahf.cmd
The path to AHFCmd.exe in that directory. (I'm using Windows 7, not sure about other OSes)

You have to escape the backslashes with \, even though the path to the ditamap does not have to use escaped backslashes (arcane!). So the following command seems to work with OT 1.7.5 without the local.properties file as described earlier:

ant -Dargs.input=C:\path\to\map\my.ditamap -Dtranstype=my-pdf -Dpdf.formatter=ah -Dahf.dir=C:\Program Files\Antenna House\AHFormatterV62 -Dahf.cmd=C:\Program Files\Antenna House\AHFormatterV62

@shaneataylor
Copy link
Contributor

@markgif I think we addressed the properties file with some doc changes here: http://www.dita-ot.org/2.3/user-guide/build-using-dita-properties-file.html

Let the team know if you're satisfied we've addressed that issue. I opened #101 and #102 to address the other two issues raised here.

Thanks!

@infotexture infotexture removed this from the 2.4 milestone Nov 14, 2016
@infotexture infotexture modified the milestone: 2.4.3 Jan 10, 2017
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 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
None yet
Development

No branches or pull requests

3 participants