Requirements Description supports Markdown and HTML

 

Requirements Description supports Markdown and HTML

OpenRose - Requirements Management

An Open Source and FREE Requirements Management Application / Tool

Direct Link to YouTube Video : https://www.youtube.com/watch?v=CZlr8VaiVnY
 

Video Transcript :

Hello and welcome to OpenRose, an open-source and free requirements management application. You can find more information at https://github.com/openrose.

Today we are going to talk about the requirement description field, which is a markdown field. Let me go to a project in Treeview, expand all the data, and here is one of the requirements under a requirement type or an item type that has a table format. When you provide headings in the first row and a separator in the second row with further rows as the table data, this is a markdown format, and this format is converted into a table form.

Markdown also allows users to capture different formatting within the description box. When you click on the question mark here, which is a markdown guide, it will take you to this location on the internet. You can use a single hash to create a large heading, which is H1 in HTML. You can insert other headings by increasing the number of hashes you put in front of your text. There are other ways, such as using H1 and H2 with dotted lines. You can also define line breaks by inserting spaces in your lines, automatically inserting line breaks for you.

To highlight certain text, you can select that text and put two asterisks in the front and at the end to highlight or mark the text as bold. You can also do it like this: if you use a single star or underscore, it will mark the text as italic. You can do both italic and bold together. You can also highlight certain text as a quote by putting a greater-than sign in front, and it will appear as a quote. Nested quotes can be created with two greater-than signs. When you look at these guides, you can easily find out how to insert your data within your application using markdown formatting.

On the right-hand side, you can see different types of formatting. You can do lists, code, horizontal lines, links, images, escape characters, and more. You can also insert HTML, but it is advisable to keep your markdown as a simple text-formatted document, which is then converted into HTML. There are several reasons why we may encourage users not to use certain types of HTML tags, as that could be a security risk. Embedding frames and certain types of scripts may be blocked in the OpenRose application.

It's simple to pick up any of these formats and insert this data into your description box, and it will appear in a nicely formatted view. Here we are showing the details in the preview panel, but you can also click on the preview button to convert the markdown box itself from text to a preview, or you can keep your preview on the side. Personally, I prefer to keep it at the bottom and update it at the top to see the effects of those changes in the final output.

Here is an example where you can see I have square brackets and normal brackets. When we put them together, we create a link like this. Let me see if I have other examples that could be useful. Here we have a star, which should be converted into a bullet point. We have several bullet points appearing here as bullet points. I also have a table containing some bullet points. Here is an example of marking a text as bold and having a text that is more like a quote. This is because it is indented in this particular case. Indentation marks the text as a quote. If I have just one single asterisk or star sign, it marks the text as italic.

All this is important for people and users who are using this application to ensure they insert their description for the requirements in the correct formatted text. We believe the supported formats available within the system should provide a great start to capture contextual information about the requirement in the description form. Inserting links allows users to link to external documents, models, or pictures stored outside of OpenRose, providing more detailed information about the requirement. This can be easily linked using the link option within the description itself.

With that, thank you so much for your time today, and have a great day!