Markdown document modifiers examples - EdoFro/Freeplane_MarkdownHelper GitHub Wiki
/ Tutorial Examples / Markdown document / Markdown document modifiers examples
<<< Markdown document - MDH nodes >>>
Modifiers are icons or attributes that change the logic the Markdown Document node uses to build the markdown document in the node's note.
Table of contents
Icons
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.
1. 'Leaf' icon
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.
2. 'no entry' icon
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.
3. 'see-no-evil monkey' icon
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.
Attributes
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.
1. headersToUnderline
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.
2. lineOverHeader
If 'true' the extra line goes over the Headers, not under them
3. hideFolded
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.
4. Headers numbering
4.1. headerNumbering
This attribute indicates if the headers must be numbered or not
4.2. topHeadersNumbered
This attribute indicates if the top header level must be included in the headers numbering or not.
4.3. topHeaderStartingNumber
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.
4.4. example
5. fileLinksRelative
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.
= edofro.MarkDownHelper.MDH.plainTaskList(node)
!
--- No file found!! ---
6. ignoreHeaderDetails
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
- Ignoring the headers details
- Including the headers details
7. ignoreHeaderNotes
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
- Ignoring the headers notes
- Including the headers notes
8. ignoreLeafDetails
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
- Ignoring the leafs details
- Including the leafs details
9. ignoreHeaderImageObjects
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.
- Ignore header images
- Include header images
