Memo Template v1
Information to call the Memo Template v1
- API End Point:
- https://api.advicement.io/v1/templates/pub-general-json-to-pdf-template-v1/compile
- Authentication:
- Use your API Security Token (which is generated in your dashboard) in the Adv-Security-Token header parameter
Refer to our authentication guide for more information.
- Uses Luatex:
- FALSE
- Uses Charts:
- FALSE
- Available On:
Memo Template
The Memo Template is a comprehensive and adaptable tool designed to streamline your internal communication process. This state-of-the-art solution transforms your message data, structured in JSON format, into a clear, ready-to-distribute PDF memo using the DynamicDocs API.
This user-friendly template offers options for personalizing the memo's layout, covering various fields such as memo date, sender and recipient details, subject, and main content. By integrating your data in JSON format, you can effortlessly manage complex data configurations, leading to more accurate and efficient communication.
The template utilizes the DynamicDocs API to convert your JSON data into a professional, printable PDF memo. It ensures top-quality, standardized memos that reflect your organization's commitment to clear and effective communication.
Use Cases for JSON to PDF Conversion
- Corporate Offices: Ideal for businesses that require frequent internal communication, this template simplifies the creation and distribution of standardized memos for various departments.
- Educational Institutions: This template is perfect for schools and universities to disseminate information to faculty, staff, or students, ensuring consistent communication.
- Government Agencies: For agencies that need to circulate directives, announcements, or updates, this template ensures that each document adheres to a consistent format.
- Non-Profit Organizations: Charities and NGOs can leverage this template to communicate with their teams, volunteers, or stakeholders, maintaining a uniform appearance.
- Healthcare Institutions: Hospitals and clinics can use this template to convey guidelines, updates, or announcements to their staff in a standardized manner.
- Event Management: This tool can be integrated into event management systems, converting event details and updates into memos for distribution to teams or attendees.
Key Takeaways
In summary, our Memo Template serves as an invaluable tool for any organization aiming for clear and consistent internal communication, ensuring the quick, automated generation of compliant PDF memos.
documentSettings - A JSON object which contains the settings of the template (primaryHEXColour, secondaryHEXColour, textHEXColour, font, documentName, logo, logoType, logoWidth, margins, headSep, footSkip, showframe, header, footer).
font - An optional string which contains the font of the document. Possible options are: 'helvetica', 'avant garde', 'sans serif', 'charter', 'open sans', 'bera', 'venturis', 'raleway', 'overlock', 'roboto', 'spectral', 'clear sans', 'noto sans', 'noto mono', 'josefin', 'bera sans', 'latin modern', 'theano modern', 'droid sans', 'fira sans', 'XCharter', 'bookman', 'gyre bonum', 'gyre schola', 'gyre termes'.
fontSize - An optional integer which contains the font size of the document. Possible options are: 8, 9, 10, 11, 12, 14.
primaryHEXColour - An optional string which contains the primary font colour of the document.
secondaryHEXColour - An optional string which contains the secondary font colour of the document.
textHEXColour - An optional string which contains the text font colour of the document.
documentName - An optional string for the name of the document.
topMargin - An optional string containing the top margin size (in cm).
rightMargin - An optional string containing the right margin size (in cm).
bottomMargin - An optional string containing the bottom margin size (in cm).
leftMargin - An optional string containing the left margin size (in cm).
headheight - An optional string relating to the height of the header (in cm). See LaTeX geometry package documentation for more information on this parameter.
headSep - An optional string relating to the space between the header and the beginning of the document (in cm). See LaTeX geometry package documentation for more information on this parameter.
footSkip - An optional string relating to the space between the end of the document and the footer (in cm). See LaTeX geometry package documentation for more information on this parameter.
includehead - A boolean expression which determines whether the header is part of the top margin (false) or below it (true).
includehead - A boolean expression which determines whether the footer is part of the bottom margin (false) or below it (true).
showFrame - A boolean expression (true/false) to show the frame of the document.
header - An object containing settings to control the header.
headerLine - A boolean expression that generates a horizontal line between the header and the beginning of the document.
leftContent - The content that appears on the left-hand side of the header. Can contain LaTeX commands, text or simply 'logo'.
centreContent - The content that appears in the centre of the header. Can contain LaTeX commands, text or simply 'logo'.
rightContent - The content that appears of the right-hand side of the header. Can contain LaTeX commands, text or simply 'logo'.
adjustMargin - An optional string containing whether the header margin needs to be adjusted sideways (in cm).
footer - An object containing settings to control the footer.
footerLine - A boolean expression that generates a horizontal line between the footer and the end of the document.
leftContent - The content that appears on the left-hand side of the footer. Can contain LaTeX commands, text or simply 'logo'.
centreContent - The content that appears in the centre of the footer. Can contain LaTeX commands, text or simply 'logo'.
rightContent - The content that appears of the right-hand side of the footer. Can contain LaTeX commands, text or simply 'logo'.
adjustMargin - An optional string containing whether the header margin needs to be adjusted sideways (in cm).
latexPreamble - Contains custom LaTeX commands which will be inserted before '\begin{document}'.
documentContent - A JSON object which contains the content of the template and other data for charts and tables).
content - A required object which contains the data for the right column on the first page.
type - A required string which contains the type of text for the body of the document. Possible options are: 'heading', 'section', 'subsection', 'paragraph', 'newpage', 'enumerate', 'itemize', 'table'.
content - A required string or array of strings which contains the text for the body of the document. Can contain LaTeX commands. Note that in an event of a table, this contains the key-name for the table.
order - A required number which determines the order of the text.
height - An optional parameter controling the height of the chart.
width - An optional parameter controling the width of the chart.