Jama as a technical writer tool

Francisco Espain
Francisco Espain Member Posts: 4
edited March 13 in Peer-to-Peer Support Forum

Hi, we are considering using Jama as an tool to write technical documentation like a manual or datasheet.
We are using velocity, but we would like a third party tool to create the style/template for the output document.
Velocity is very handy and is great to create tables of information, but it would be hard to maintain the esthetics of the document,
Does someone has this issue, what are you using/doing?
Thanks

------------------------------
Francisco Espain
------------------------------
Francisco Espain
MPS

Comments

  • Colin Marquardt
    Colin Marquardt Member, Data Exchange Posts: 15
    edited May 2023

    We are using the REST API (with the Python client) to get the data, render it to HTML via Jinja2 templates, and then use weasyprint to convert the HTML (and a bit of CSS) to PDF. Works quite well. Using HTML as the intermediate format has the advantage that you can just use the chunks of HTML that you get from rich text fields for lists,  tables, images etc.
    I initially tried to use the "GET attachments" API endpoint for embedded images, but you actually have to use "GET files" to successfully download them - thanks go out to Alessandro Valli who wrote about it here a while ago.

    ------------------------------
    Colin Marquardt
    Bosch Sensortec GmbH
    ------------------------------
    -------------------------------------------
    Original Message:
    Sent: 05-11-2023 06:50
    From: Francisco Espain
    Subject: Jama as a technical writer tool

    Hi, we are considering using Jama as an tool to write technical documentation like a manual or datasheet.
    We are using velocity, but we would like a third party tool to create the style/template for the output document.
    Velocity is very handy and is great to create tables of information, but it would be hard to maintain the esthetics of the document,
    Does someone has this issue, what are you using/doing?
    Thanks

    ------------------------------
    Francisco Espain
    ------------------------------
  • Francisco Espain
    Francisco Espain Member Posts: 4
    edited May 2023

    Thank you Colin, that Get files its a great news we had problem with that and, that's why we went for velocity

    ------------------------------
    Francisco Espain
    ------------------------------
    -------------------------------------------
    Original Message:
    Sent: 05-12-2023 00:06
    From: Colin Marquardt
    Subject: Jama as a technical writer tool

    We are using the REST API (with the Python client) to get the data, render it to HTML via Jinja2 templates, and then use weasyprint to convert the HTML (and a bit of CSS) to PDF. Works quite well. Using HTML as the intermediate format has the advantage that you can just use the chunks of HTML that you get from rich text fields for lists,  tables, images etc.
    I initially tried to use the "GET attachments" API endpoint for embedded images, but you actually have to use "GET files" to successfully download them - thanks go out to Alessandro Valli who wrote about it here a while ago.

    ------------------------------
    Colin Marquardt
    Bosch Sensortec GmbH
    ------------------------------

    Original Message:
    Sent: 05-11-2023 06:50
    From: Francisco Espain
    Subject: Jama as a technical writer tool

    Hi, we are considering using Jama as an tool to write technical documentation like a manual or datasheet.
    We are using velocity, but we would like a third party tool to create the style/template for the output document.
    Velocity is very handy and is great to create tables of information, but it would be hard to maintain the esthetics of the document,
    Does someone has this issue, what are you using/doing?
    Thanks

    ------------------------------
    Francisco Espain
    ------------------------------
    Francisco Espain
    MPS

Categories