/ Tutorial Examples / Markdown document

---

<<< Tutorial Examples - Markdown document modifiers examples >>>

• Markdown document modifiers examples

• Table of contents

• Foreground

• The "Markdown document.md" node

  • 1. Definition

  • 2. Basic logic

  • 3. Basic logic example

  • 4. Modifiers

    • 4.1. Icons

    • 4.2. Attributes

Before trying to understand this AddOn, it is good to know how the Markdown notation works and how you can use it in Freeplane. I recomend you to have a look at the
----
--- No wiki page found!! ---
---- page first.

It is also good to have a little knowledge
----
--- No wiki page found!! ---
----, what they are, how they work and when they get updated. Just to know that they exist and that this addon relies on them.

The "Markdown document.md" node is the central Markdown Helper feature. This node builds a Markdown document in its note by collecting information from its descendants.

The node has a formula in its note. This formula, every time it's recalculated, builds the markdown document in the note. This way the note shows an updated version of the document every time the nodes in the branch are edited or reordered.

Here you can see a simple example of this kind of nodes with descendants and how the builded document in its note looks like:

• Parent nodes
  • Nodes that have children are considered as headers.
  • The text in the node is assigned as the header's text.
  • If the node has details or a note, they are considered as the first paragraphs under this header in the document.
• Leaf nodes
  • Nodes without children are considered as document paragraphs.
  • If the node has details or a note, then the node's text is ignored and only the details and the note are included in the final document.

in this image you can see that:

• the "Chapter 1" node has details and a note
• the text in this details is shown as the first paragraph under the header "Chapter 1"
• The next paragraph is the text that is in the note (not shown in the image)
• The last node bottom right is a leaf node (has no children)
• It has a note and no details.
• The text on the node is ignored in the final document and the last paragraph is the text in the node's note

Here is animated for better understanding:

Modifiers are icons or attributes that change the logic the Markdown Document node uses to build the markdown document in the node's note.

Following icons can be used in the nodes of the branch to indicate to the Markdown Document node that those node must be interpreted in an special way.

Modifier	Explanation
	This 'leaf' icon indicates that the node must be treaten as a leaf node by the Markdown Document node. That means that its children won't be considered: they are invisible for the logic when building the markdown document. This way you can add extra information in any branch that is useful to you but won't be shown in the document. You can have a node that use a formula to get some result from its descendants and show only this result, but have the posibility to have the information you used to get this result right there and modify it if needed. The Freeplane mindmapping way.
	The 'no entry' icon indicates that the node and all its desendants must be totally ignored by the Markdown Document node. They are invisible when building the markdown document. This way you can add extra information that you don't need to be shown in the document.
	The 'see-no-evil monkey' icon indicates that the content of the node must be ignored by the Markdown Document node, but only this node, not its descendants. They stay visible for the Markdown Document node when building the markdown document. This may help when you want to create some groups in the nodes tree, but you don't want that this affects the document structure.

The "Markdown Document.md" node has the following attributes that can be used to get different results when building the markdown document in the node's note.

It is good to know that if you have a markdown document inside another one, the logic uses the attributes values from the parent.

Modifier	Posible values	Explanation
headersToUnderline	0, 1, 2, 3, ...	This Attribute indicates if the builder must add an extra line under the headers. The value indicates how many header's levels must be underlined. 0 indicates no underlining.
lineOverHeader	true, false	If 'true' the extra line goes over the Headers, not under them
hideFolded	true, false	This attribute indicates if nodes that are folded must be ignored by the Markdown document builder or not. This works the same way as adding the 'no entry' icon to those nodes.
headerNumbering	true, false	This attribute indicates if the headers must be numbered or not
topHeadersNumbered	true, false	This attribute indicates if the top header level must be included in the headers numbering or not.
topHeaderStartingNumber	0, 1, 2, 3, ...	This attribute indicates the starting number for the headers numbering. This can be useful if you have separate documents for each chapter of a bigger book, for example.
fileLinksRelative	true, false	This attribute indicates if the *links MDH nodes' must translate the URIs as relative or absolute ones. This is helpful to view the images or link the files if working in your own computer, but be able to export it to web location or other computer and continue working.
ignoreHeaderDetails	true, false	Indicates if the Markdown document should ignore the details text from headers. If 'true' you can use them to add your own notes that won't appear in the markdown document
ignoreHeaderNotes	true, false	Indicates if the Markdown document should ignore the text in the Notes from header nodes. If 'true' you can use them to add your own notes that won't appear in the markdown document
ignoreLeafDetails	true, false	Indicates if the Markdown document should ignore the details text from leaf nodes. If 'true' you can use them to add your own notes in the deatils that won't appear in the markdown document
ignoreHeaderImageObjects	true, false	Indicates if the Markdown document should ignore the images embeded in header nodes. If 'true' they won't appear in the markdown document directly. You should use the 'local image' node for the image to be included in the document then.

---

<<< Tutorial Examples - Markdown document modifiers examples >>>