• State Verified Answer
  • Replies 3 replies
  • Answers 1 answer
  • Subscribers 46 subscribers
  • Views 2866 views
  • Users 0 members are here
Options
Related

Using the 2.5 API to download a DITA publication

Rich R

Is there an API in the 2.5 version that allows the downloading of a publication in DITA format?  I need to user dot.net for this rather than PowerShell.

Thanks.
Rate translation
×
Suggest better translation
×
Parents
  • 0
    Hi Rich

    Yes there is. To give the best example, all data you see in Publication Manager is handled using the same public API that you can and should use.

    To be complete I have to mention that there is no 'single' API call that achieves what you describe here. This theoretically can work as demo-ware but since we have enterprise customers with massive amounts of data that API would eventually fail for some data size.

    Based on your one liner... what about using the Publish(Service) system even through some code automation... In essence you trigger a publish operation (which handles, versions, languages, resolutions, etc) to the "DITA XML" OutputFormat, it can handle the enterprise sizes and returns you file-system DITA... which you can download through automation as a ZIP file from the PublicationOutput where you triggered it from.

    Best wishes,
    Dave

    PS: The primary goal of ISHRemote is to be a PowerShell module. On the side it was discussed and still is a great example of a light-weight client library. What I mean here is that ISHRemote in essence is a C# DLL, which theoretically can work for you.
  • 0 in reply to Dave De Meyer
    Thanks Dave,

    I am trying to figure out the best way to get all the objects in a pub, in top down order of the pub. That would be the purpose of the download of the DITA file. I don't need to download images, only the XML. This would be run one pub at a time, as needed, much like using the pub report function in the current web client, but with additional fields being downloaded (object location, word count, ...). The interface would require one single map GUID to be entered - and only one DITA file to be downloaded, occasionally.

    I'm not sure if this is the best approach.
  • 0 in reply to Rich R
    Still a bit confused if you are creating a report (with an occasional possibility of download) or are truly downloading everything (this thread title)?

    Most reports are baseline based, so do not actually load and parse the xml files to show all referenced topics "in order of appearance". To keep those reports speedy they make use of FISH*LINKS metadata fields that are populated at xml checkin time.

    Accurate reporting can only be achieved at publishing time, as eventually the context, files, reuse mechanisms,... even DITA-OT... decide what the final outcome is.
Reply Children
No Data