Installing and first steps - EdoFro/Freeplane_MarkdownHelper GitHub Wiki

/ Home / Installing and first steps

<<< Screenshots - Markdown Helper Menu >>>

1. Table of Contents

2. Installing the AddOn

Installing a new AddOn is very straight forward in Freeplane.

You only need to follow these simple steps:

  1. Download the latest release of the addOn
  2. Open it in Freeplane
  3. A first dialog will open.Install 001.png
  4. Click Yes and follow the instructions.
  5. Close and reopen Freeplane to complete the installation.

More information about Add Ons and how to install them in Freeplane can be found in the oficial Freeplane wiki: Add-ons_(install).

3. Setting your map up

The map where you want to use this AddOn needs to have two custom format styles to work properly.

Their names are:

  • MarkdownHelperNode
  • MarkdownHelperLink

So, you need to add them to your map before using the AddOn on it.

To do that, you have different choises

  • import them from a template map
  • create them manually

A brief explanation:

3.1. Using the Markdown Helper Template Map

Map templates are an excellent tool to easily format your maps the way you like and to mantain a standarized outlook between them.

Since Freeplane v1.9.0 you have the possibilty to import formats from multiple template maps and assign template maps to be followed. This way you define any change in you base template and all your maps will follow these changes.

3.1.1. getting the styles

This AddOn has its own template map that you can find in the user templates folder.

To add the custom format styles needed for the AddOn to work in your map you have to follow these steps

  1. open the map you want to work with
  2. use the menu command:Format / Manage styles / Copy map styles from ...
  3. the "open" dialog appears
  4. Select in "Files of type" the option "User templates"FilesOfType.png
  5. Select the Markdown Helper template map in the MarkdownHelper folder and open it.

Now your map have these two new formats adn your ready to go!

3.1.2. some additional information:

Your map took also the standard formats from the template. If you don't like them you can copy the formats from your own template and the styles will change again, but the custom Styles needed for this AddOn will remain.

I recomend you to make your own templates and that they have all the custom styles you need.

I also recomend you to make a copy of the Markdown Helper template map and modify the styles the way you like them, so you can use this map as your template when using the addon.

Do not use the original template map to customize the styles, because every time the AddOn get updated your customization will beet lost. Not a big deal, but certainly anoying.

3.2. Creating custom Styles manually

The other way is to create the two styles manually.

This may be a better option if you have already created a lot of custom styles or customized the standard styles in the map and you don't have a copy of these styles in a template.

I recomend you to create a template and learn how to use them. They are very useful. But in the meantime you can do this:

3.2.1. Option A: Create style from selection

This is the simpliest way to crate a new style:

  • Add a new node
  • Change some format options to the nodeFor example:
    • Node background color
    • Node Text color
    • Node shape
    • Add some icon
  • Select the node
  • Apply menu command:Format / Manage Styles / new style from selection
  • Enter MarkdownHelperNode as new style's name(*)
  • Repeat all again to create the MarkdownHelperLink (*) custom style

(*) The names must be written the same as shown here, including upper and lower cases.

3.2.2. Option B: Edit Styles...

You can create the styles (or modify them) in the "Edit Styles ..." map

It is very similar as the previous procedure: The difference is that you name the style first, when creating the node, and then you do the changes to the node.

  • use menu commandFormat / Manage Styles / Edit Styles...
  • the styles map opens
  • Select a node with a Style to use as starting format
    • for example Details or Attributes
  • Right click on it and aselect "new style from selection" option
  • Enter MarkdownHelperNode as new style's name(*)
  • change the format of the new node the way you like
  • Repeat all again to create the MarkdownHelperLink (*) custom style
  • close the editor by clicking the green check icon or by pressing Ctrl + Enter

<<< Screenshots - Markdown Helper Menu >>>