Edit JSON-LD string fields as Markdown in Twinfox Studio
Learn how to use the new feature that gives you more control over the formatting and appearance of your text in linked data objects.
If you already use the Twinfox Linked Data Management Platform, you know how powerful and flexible it is to work with model-based structured information. These are hypergraph objects made easy to define, edit, use and share within and across organizations as JSON-LD.
Twinfox helps you revolutionize your business information management and sharpen your competitive edge by moving from tabular data to graphs of linked data objects that are bound to an adjustable, controlled and flexible information model.
But what if you want to make your text in linked data objects more expressive and engaging? What if you want to add headings, lists, links, bold, italic, and more to your text fields? That's where the new feature of Twinfox comes in: formatted editing support for editing string fields as Markdown.
What is Markdown and why use it?
Markdown is a simple and widely used markup language that lets you create formatted text using plain text syntax. You can use markdown to add headings, lists, links, bold, italic, and more to your text without having to use HTML tags or a rich text editor. Markdown is easy to learn, write, and read, and it can be converted to HTML or other formats.
You can even use Markdown as a base for structured and component content with Lightweight DITA using the MDITA profile with Twinfox Studio to help you manage the structured YAML frontmatter and as a Linked Data hypergraph Content Management System (CMS).
Using Markdown in your string fields gives you easy control over the formatting and appearance of your text in linked data objects. You can make your text more readable, organized, and attractive, and you can convey your message more effectively. You can also use Markdown to create links to other linked data objects or external resources, which can enhance the interactivity and usability of your information.
How to use Markdown in Twinfox Studio?
To use Markdown in Twinfox Studio, you need to have a string field in your information model which comes by default using the Blogpost type. You can create such a field by selecting the String option from the drop-down menu in the field editor. Every string field can be toggled to be edited as a markdown string. Below is what it looks like.
Once you select to edit a string field as Markdown, you can start writing your text using the markdown syntax or use the shortcut buttons to format the text. You can use the following basic markdown elements to format your text:
- Use # for headings. The number of # symbols determines the level of the heading. For example, # Heading 1, ## Heading 2, ### Heading 3, and so on.
- Use * or _ for emphasis. Enclose the text you want to emphasize with * or _ symbols. For example, *italic*, **bold**, or ***bold and italic***.
- Use - or * for lists. Start each list item with a - or * symbol followed by a space. For example, - item 1, - item 2, - item 3, and so on.
- Use [] and () for links. Enclose the text you want to display as a link with [] symbols, and follow it with the URL of the link enclosed with () symbols. For example,
[Twinfox]([URL]). - Use ![] and () for images. Similar to links, but add a ! symbol before the [] symbols. For example,
.
You can also use other markdown elements, such as blockquotes, code blocks, tables, and more. For a complete reference of the markdown syntax, you can check this open source Markdown Getting Started Guide.
As you write your text using the markdown syntax, you can see the preview of the formatted text below the input box. You can also toggle between the edit and preview modes by clicking on the icons on the top right corner of the string field editor.
When you attach a Markdown trait (reusable data structure) to a type or subtype, the document navigation view will render the markdown as a preview when you navigate the contents using Twinfox Studio. It also helps you navigate between linked objects and shows all the back-refences to the object as well.
What are the benefits of using Markdown in Twinfox?
Using Markdown in Twinfox Studio has several benefits for you and your users. Here are some of them:
- You can create formatted text in linked data objects without having to use HTML tags or a rich text editor. This makes your text easier to write, read, and maintain.
- You can use Markdown to create links to other linked data objects or external resources, which can enhance the interactivity and usability of your information.
- You can use Markdown to create headings, lists, and other elements that can improve the readability, organization, and attractiveness of your text.
- You can use Markdown to convey your message more effectively and expressively, which can increase the engagement and satisfaction of your users.
- You can use Markdown for both longer and shorter snippets of texts and render in the platform you are creating to make it easier to update content
- You can use Markdown to create consistent and standardized formatting across your linked data objects, which can improve the quality and reliability of your information.
Conclusion
Twinfox Studio is a powerful and flexible platform that lets you work with model-based structured information with objects that are easy to define, edit, use and share within and across organizations. Twinfox helps you revolutionize your business information management and sharpen your competitive edge by moving from tabular data to graphs of linked data objects that are bound to an adjustable, controlled and flexible information model, and use modern content formats to promote content reusability by separating rendering from contents.
With the new feature of formatted editing support for editing string fields as Markdown, you can now use Markdown to create formatted text in your JSON-LD linked data objects. This gives you more control over the formatting and appearance of your text, and lets you create headings, lists, links, and more. Using Markdown in Twinfox Studio can help you improve the readability, organization, attractiveness, interactivity, usability, quality, and reliability of your information, and increase the engagement and satisfaction of your users.
If you want to learn more about Twinfox Studio and how it can help you with your business information management needs, sign up for a free trial below, or contact us. We would love to hear from you, and show you how the Twinfox Studio can make your information processing easier and better.
