Improve the bc template

imagej · Apr 13, 2021 · 0c1db28 · 0c1db28
1 parent a92c298
commit 0c1db28
Show file tree

Hide file tree

Showing 256 changed files with 853 additions and 840 deletions.
diff --git a/_includes/bc b/_includes/bc
@@ -1,4 +1,14 @@
-{% if include.color %}{% if include.color == "black" %}{% assign bc = include.content | replace: "|", " ▶ " %}<span class="bc">{{bc}}</span>{% endif %}
-{% if include.color == "white" %}{% assign bc = include.content | replace: "|", " ▷ " %}<span class="bc">{{bc}}</span>{% endif %}
-{% if include.color == "none" %}{% assign bc = include.content | replace: "|", " › " %}<span class="bc">{{bc}}</span>{% endif %}
-{% else %}{% assign bc = include.content | replace: "|", " › " %}<span class="bc">{{bc}}</span>{% endif %}
+{%- case include.style -%}
+  {%- when "filled" -%}
+    {%- assign sep = ' ▶ ' -%}
+  {%- when "hollow" -%}
+    {%- assign sep = ' ▷ ' -%}
+  {%- else -%}
+    {%- assign sep = ' › ' -%}
+{%- endcase -%}
+{%- assign tokens = include.path | split: "|" -%}
+<span class="bc"><span>{{tokens[0] | strip}}</span>
+{%- for token in tokens offset:1 -%}
+{{sep}}<span>{{token | strip}}</span>
+{%- endfor -%}
+</span>
diff --git a/_pages/Brightness_and_Contrast.md b/_pages/Brightness_and_Contrast.md
@@ -12,15 +12,15 @@ This tool may be used to adjust the brightness and contrast of an active image.
 Usage
 -----
 
-The Brightness and Contrast tool may be accessed through {% include bc content='Image | Adjust | Brightness/Contrast'%} or {% include key content='Ctrl\|Shift\|C' %}.
+The Brightness and Contrast tool may be accessed through {% include bc path='Image | Adjust | Brightness/Contrast'%} or {% include key content='Ctrl\|Shift\|C' %}.
 
 <figure><img src="/media/Brightness Contrast Window.png" title="Brightness_Contrast_Window.png" width="266" height="177" alt="Brightness_Contrast_Window.png" /><figcaption aria-hidden="true">Brightness_Contrast_Window.png</figcaption></figure>
 
 The upper and lower limits of the display range can be adjusted by modifying the minimum and maximum settings. Image brightness and image contrast can be modified by using the brightness and contrast sliders or by using the arrows on the right of the window to adjust the range.
 
 Selecting 'OK' will make the specified changes to the display and close the Brightness/Contrast window. All channels in an image will be simultaneously updated automatically.
 
-ImageJ may provide intelligent thresholding based on the image's histogram through {% include bc content='Image | Adjust | Auto-Contrast'%} or {% include key content='Ctrl\|Alt\|Shift\|L' %}. Repeated usage of this process will allow more pixel values to become saturated.
+ImageJ may provide intelligent thresholding based on the image's histogram through {% include bc path='Image | Adjust | Auto-Contrast'%} or {% include key content='Ctrl\|Alt\|Shift\|L' %}. Repeated usage of this process will allow more pixel values to become saturated.
 
 Example
 -------

diff --git a/_pages/Diadem_Challenge_Data.md b/_pages/Diadem_Challenge_Data.md
diff --git a/_pages/Fix_non-functional_ImageJ_after_Update.md b/_pages/Fix_non-functional_ImageJ_after_Update.md
@@ -8,7 +8,7 @@ description: test description
 {% include outdated%}
 
 
-Unfortunately, there was a bug in the [ImageJ updater](/plugins/updater) that affected the update of the updater itself. The easiest way to get back a functional updater is to import [this URL](https://github.com/fiji/fiji/raw/master/plugins/Scripts/Plugins/Utilities/Fix_Updater.js) via {% include bc content='File | Import | URL...'%}.
+Unfortunately, there was a bug in the [ImageJ updater](/plugins/updater) that affected the update of the updater itself. The easiest way to get back a functional updater is to import [this URL](https://github.com/fiji/fiji/raw/master/plugins/Scripts/Plugins/Utilities/Fix_Updater.js) via {% include bc path='File | Import | URL...'%}.
 
 If that does not work, please delete the files *ij-ui-swing-updater-2.0.0-SNAPSHOT.jar*, *ij-updater-core-2.0.0-SNAPSHOT.jar* and *ij-core-2.0.0-SNAPSHOT.jar* from the *Fiji.app/jars/* directory (MacOSX users, {% include key content='Ctrl' %}+{% include key content='click' %} on the Fiji icon and select *Open Package Contents* and open the *jars/* directory you see there). After that, the Updater should magically repair itself.
 

diff --git a/_pages/Help_on_Menu_Item.md b/_pages/Help_on_Menu_Item.md
@@ -5,7 +5,7 @@ categories: Help
 description: test description
 ---
 
-The convenient command {% include bc content='Help | Help on Menu Item'%} allows you to open pages on specific menu items:
+The convenient command {% include bc path='Help | Help on Menu Item'%} allows you to open pages on specific menu items:
 
 ![](/media/Help-On-Menu-Item.png "Help-On-Menu-Item.png")
 

diff --git a/_pages/How_to_apply_a_common_operation_to_a_complete_directory.md b/_pages/How_to_apply_a_common_operation_to_a_complete_directory.md
@@ -8,7 +8,7 @@ description: test description
 How to apply a common operation to a complete directory
 -------------------------------------------------------
 
-Often you want to apply a common operation to all images in a given directory. This tutorial tries to help you doing this. In addition, the [Script Editor](/scripting/script-editor) provides a template via {% include bc content='Templates | IJ1 Macro | Process Folder'%} that helps getting started quickly.
+Often you want to apply a common operation to all images in a given directory. This tutorial tries to help you doing this. In addition, the [Script Editor](/scripting/script-editor) provides a template via {% include bc path='Templates | IJ1 Macro | Process Folder'%} that helps getting started quickly.
 
 Step 1: record a macro
 ----------------------

diff --git a/_pages/How_to_make_a_new_tutorial.md b/_pages/How_to_make_a_new_tutorial.md
@@ -13,7 +13,7 @@ In Fiji, we have a plugin whose only purpose is to write tutorials to be publish
 First step: call the Tutorial Maker
 -----------------------------------
 
-After clicking on {% include bc content='Plugins | Utilities | Fiji | New Fiji Tutorial'%}, you will be asked for the title of your tutorial:
+After clicking on {% include bc path='Plugins | Utilities | Fiji | New Fiji Tutorial'%}, you will be asked for the title of your tutorial:
 
 ![](/media/How to make a new tutorial-PageTitle.jpg "How_to_make_a_new_tutorial-PageTitle.jpg")
 
@@ -37,7 +37,7 @@ In any of the two modes, the snapshot window will hide itself before taking the
 
 <img src="/media/How to make a new tutorial-MakeSnapshots.jpg" width="640"/>
 
-After taking some or all of the snapshots you want to include in your tutorial, you have to crop them. Just select the appropriate rectangle, and then click on ImageJ's {% include bc content='Edit | Crop'%} or hit {% include key content='Ctrl' %}+{% include key content='Shift' %}+{% include key content='X' %}:
+After taking some or all of the snapshots you want to include in your tutorial, you have to crop them. Just select the appropriate rectangle, and then click on ImageJ's {% include bc path='Edit | Crop'%} or hit {% include key content='Ctrl' %}+{% include key content='Shift' %}+{% include key content='X' %}:
 
 ![](/media/How to make a new tutorial-CropSnapshot.jpg "How_to_make_a_new_tutorial-CropSnapshot.jpg")
 
@@ -53,7 +53,7 @@ This will pop up another dialog which lets you change the name of the image:
 
 ![](/media/How to make a new tutorial-Rename2.jpg "How_to_make_a_new_tutorial-Rename2.jpg")
 
-The other method is to select the image and click on ImageJ's {% include bc content='Image | Rename...'%} menu item.
+The other method is to select the image and click on ImageJ's {% include bc path='Image | Rename...'%} menu item.
 
 In both cases, the image references in the text will be adjusted automatically.
 

diff --git a/_pages/ImageJ2_Documentation_Edit_Options_Compatibility.md b/_pages/ImageJ2_Documentation_Edit_Options_Compatibility.md
@@ -5,7 +5,7 @@ categories: software
 description: test description
 ---
 
-This page documents the {% include bc content='Edit | Options | Compatibility'%} command dialog.
+This page documents the {% include bc path='Edit | Options | Compatibility'%} command dialog.
 
 Some commands have an associated ImageJ 1.x compatibility mode flag. The flag setting affects how some commands behave in ImageJ. The authors of ImageJ2 want to provide a mechanism whereby ImageJ 1.x behavior can be overridden when it makes sense. This allows breaks to be made with the past if necessary. Setting the mode to "Modern" will override some ImageJ 1.x behavior while setting it to "/Compatibility" will maintain ImageJ 1.x behavior as much as possible.
 

diff --git a/_pages/ImageJ2_Documentation_Process_Math_Equation.md b/_pages/ImageJ2_Documentation_Process_Math_Equation.md
@@ -4,9 +4,9 @@ title: ImageJ2/Documentation/Process/Math/Equation
 description: test description
 ---
 
-This page documents that language that can be used to specify equations via the {% include bc content='Process | Math | Equation'%} command.
+This page documents that language that can be used to specify equations via the {% include bc path='Process | Math | Equation'%} command.
 
-The {% include bc content='Process | Math | Equation'%} dialog supports a powerful language for defining equations that can be used to fill images with data.
+The {% include bc path='Process | Math | Equation'%} dialog supports a powerful language for defining equations that can be used to fill images with data.
 
 An equation is defined by a list of index variable declarations and a formula definition. If the formula does not refer to any index variables they can be omitted from the definition. (Index variables are discussed a bit later)
 
@@ -291,4 +291,4 @@ There are numerous built in functions that can appear in an equation. For refere
 
 -   Returns the the positive distance between the input floating-point value and the floating point value next larger in magnitude.
 
-We can compare this language to the ImageJ 1.x {% include bc content='Process | Math | Macro'%} language. In ImageJ 1.x the default macro for the command is defined as "v = v + 50\*sin(d/10)". Note that this exact string is not legal syntax in the new equation language. But it can now be specified as "img+50\*sin(dctr/10)".
+We can compare this language to the ImageJ 1.x {% include bc path='Process | Math | Macro'%} language. In ImageJ 1.x the default macro for the command is defined as "v = v + 50\*sin(d/10)". Note that this exact string is not legal syntax in the new equation language. But it can now be specified as "img+50\*sin(dctr/10)".
diff --git a/_pages/Installing_3rd_party_plugins.md b/_pages/Installing_3rd_party_plugins.md
@@ -8,7 +8,7 @@ description: test description
 For users
 ---------
 
--   If the plugin is published on an [ImageJ update site](/update-sites), you can run {% include bc content='Help | Update'%} then click the *Manage update sites* button to enable it. Not only does this install the plugins for you automatically, but you will also be notified of any updates whenever they are released.
+-   If the plugin is published on an [ImageJ update site](/update-sites), you can run {% include bc path='Help | Update'%} then click the *Manage update sites* button to enable it. Not only does this install the plugins for you automatically, but you will also be notified of any updates whenever they are released.
 
 <!-- -->
 
@@ -22,7 +22,7 @@ For users
 
 This will ask you for the <u>destination</u> of the plugin, just hitting *Save* is safe.
 
--   Alternatively, use {% include bc content='Plugins | Install Plugin...'%}:
+-   Alternatively, use {% include bc path='Plugins | Install Plugin...'%}:
 
 
 <img src="/media/Install-Plugin.png" width="550"/>
@@ -32,7 +32,7 @@ This will ask you for the <u>destination</u> of the plugin, just hitting *Save*
 
 It will ask you for the file name of the plugin, and install the given file.
 
--   You can also copy the *.jar*, *.class* or *.java* files (or a script in any language Fiji supports) to *Fiji.app/plugins/*, followed by calling {% include bc content='Help | Refresh Menus'%}.
+-   You can also copy the *.jar*, *.class* or *.java* files (or a script in any language Fiji supports) to *Fiji.app/plugins/*, followed by calling {% include bc path='Help | Refresh Menus'%}.
 
 
 **Note:** On MacOSX, you need to {% include key content='Ctrl' %}+{% include key content='click' %} on the *Fiji* icon in the Finder and select *Show package contents* to see the *plugins/* folder.
@@ -54,7 +54,7 @@ The .config file should look something like this:
 
 `       File, "Show Prime Numbers", Primes_("")`
 
-where {% include bc content='File'%} is the menu you want to add the item to -- at the moment, the only valid choices are {% include bc content='Plugins'%}, {% include bc content='Plugins | <submenu>'%}, {% include bc content='File | Import'%}, {% include bc content='File | Save'%}, {% include bc content='Analyze | Tools'%}, {% include bc content='Help | About'%} and {% include bc content='Edit | Options'%}.
+where {% include bc path='File'%} is the menu you want to add the item to -- at the moment, the only valid choices are {% include bc path='Plugins'%}, {% include bc path='Plugins | <submenu>'%}, {% include bc path='File | Import'%}, {% include bc path='File | Save'%}, {% include bc path='Analyze | Tools'%}, {% include bc path='Help | About'%} and {% include bc path='Edit | Options'%}.
 
 Next comes the title of the menu item, and lastly the class name of the plugin with a parameter that will be passed to the run() method of that class. It must a fully qualified java name (e.g. com.sun.java.something) if the plugin belongs to a java package.
 

diff --git a/_pages/Keyboard_shortcuts.md b/_pages/Keyboard_shortcuts.md
@@ -11,7 +11,7 @@ ImageJ has a lot of keyboard shortcuts.
 Listing all keyboard shortcuts
 ------------------------------
 
-For a verbose list of keyboard shortcuts, call {% include bc content='Plugins | Shortcuts | List Shortcuts'%}.
+For a verbose list of keyboard shortcuts, call {% include bc path='Plugins | Shortcuts | List Shortcuts'%}.
 
 The Command Launcher
 --------------------
@@ -68,10 +68,10 @@ The key defined in square bracket is case sensitive ! If a capital letter is use
 ### Option 2: Save the macro(s) as a toolset
 
 The shortcut should be defined in square bracket like for option 1, but instead of editing the existing StartupMacros file, the macros(s) can be saved as a separate MyShortcut.ijm or .txt file in the ImageJ/Fiji subfolder `macros/toolsets`.  
-Then restart ImageJ/Fiji and click the {% include bc content='&gt;&gt;'%} at the rightmost side of the fiji toolbar and click the entry MyShortcut. This will install your macros and thus activate the associated shortcuts.  
+Then restart ImageJ/Fiji and click the {% include bc path='&gt;&gt;'%} at the rightmost side of the fiji toolbar and click the entry MyShortcut. This will install your macros and thus activate the associated shortcuts.  
 This option is more convenient to distribute macros with keyboard shortcuts to colleagues or via an update site.
 
 ### Option 3: Associate shortcut to a plugin menu entry
 
 The second possibility consist in saving the macro code as a small script file into the `./Fiji.app/scripts/Plugins/` folder, so that it appears in the menu upon restart.  
-Then you can register a shortcut using {% include bc content='Plugins|Shortcuts|Add Shortcut...'%}
+Then you can register a shortcut using {% include bc path='Plugins|Shortcuts|Add Shortcut...'%}
diff --git a/_pages/MacOSX_tips.md b/_pages/MacOSX_tips.md
@@ -21,10 +21,10 @@ Running Fiji in 32-bit mode
 
 {% include warning-box content='It may no longer be possible to start Fiji in 32-bit on recent versions of OS X. See [this bug report](https://fiji.sc/bugzilla/show_bug.cgi?id=1018) for details.' %} Fiji on Intel Macs runs on Java 1.6 in 64-bit mode. If you need to run it in 32-bit mode, you can do so as follows:
 
-1.  Launch Fiji normally, and choose {% include bc content='Edit | Options | Memory & Threads'%}.
+1.  Launch Fiji normally, and choose {% include bc path='Edit | Options | Memory & Threads'%}.
 2.  Reduce your Maximum Memory setting to \~1800 MB or less.
 3.  Quit Fiji.
-4.  {% include key content='Ctrl' %}+{% include key content='click' %} the Fiji dock icon and choose {% include bc content='Options | Show in Finder'%}.
+4.  {% include key content='Ctrl' %}+{% include key content='click' %} the Fiji dock icon and choose {% include bc path='Options | Show in Finder'%}.
 5.  {% include key content='Ctrl' %}+{% include key content='click' %} on the Fiji application icon that pops up, and choose Show Info (or press {% include key content='Cmd' %}+{% include key content='I' %}).
 6.  Check the "Open in 32-bit mode" box in the Fiji info window.
 7.  Press the red X on the Fiji info window to close it.

diff --git a/_pages/Project_ideas.md b/_pages/Project_ideas.md
@@ -46,7 +46,7 @@ The project would consist of
 Interactively adjustable intensity/LUT curves
 ---------------------------------------------
 
-In Fiji, you can adjust the dynamic range of an image by calling {% include bc content='Image | Adjust | Brightness & Contrast'%}. However, this only lets you choose a linear mapping between pixel intensity and lookup table. This project aims to provide non-linear controls, such as piecewise linear functions, gamma curves, splines, etc
+In Fiji, you can adjust the dynamic range of an image by calling {% include bc path='Image | Adjust | Brightness & Contrast'%}. However, this only lets you choose a linear mapping between pixel intensity and lookup table. This project aims to provide non-linear controls, such as piecewise linear functions, gamma curves, splines, etc
 
 Image processing plugins
 ========================
@@ -199,7 +199,7 @@ We already have Jacl in Fiji, as it is a dependency of Batik. There is also a pu
 
 For Tcl, the Script Editor would need minimal adjustments, as RSyntaxTextArea already has support for Tcl, but for Haskell, a new TokenMaker would have to be implemented.
 
-Add {% include bc content='Edit | Find in files...'%}
+Add {% include bc path='Edit | Find in files...'%}
 -------------------------------------------------------
 
 We already have a mechanism to jump between compile errors and locations of a stack trace. The same mechanism could be used to present results from a search through multiple files.
@@ -357,7 +357,7 @@ And finally, the Fiji Wiki needs some love to reflect the exact titles of the me
 Add a clever *Save As* plugin
 -----------------------------
 
-For now, {% include bc content='File | Save As'%} always saves the result as a *.tiff* file, even if the user specified a file name ending in, say, *.png*.
+For now, {% include bc path='File | Save As'%} always saves the result as a *.tiff* file, even if the user specified a file name ending in, say, *.png*.
 
 Stephan Preibisch suggests: Add a plugin that determines from a set of extensions which plugin to call to the respective writer plugin.
 

diff --git a/_pages/Script_Interpreter.md b/_pages/Script_Interpreter.md
@@ -23,7 +23,7 @@ description: test description
 Getting Started
 ---------------
 
-Start it via {% include bc content='Plugins|Scripting|Script Interpreter'%} or by typing {% include key content='Shift' %}-{% include key content='\[' %}.
+Start it via {% include bc path='Plugins|Scripting|Script Interpreter'%} or by typing {% include key content='Shift' %}-{% include key content='\[' %}.
 
 ![](/media/Script Interpreter.png"Script_Interpreter.png")
 

diff --git a/_pages/Stitch_and_Align_a_sequence_of_grid_images_Tutorial.md b/_pages/Stitch_and_Align_a_sequence_of_grid_images_Tutorial.md
@@ -24,7 +24,7 @@ In our test case, we have 19,600 images, i.e. 140 sections of 10x14 tiles:
 Stitching
 ---------
 
-As a first step, we start Fiji and go to '{% include bc content='Plugins | Stitching | Stitch Sequence of Grids of Images'%}':
+As a first step, we start Fiji and go to '{% include bc path='Plugins | Stitching | Stitch Sequence of Grids of Images'%}':
 
 ![](/media/Stitching-Menu-Grid-Sequence.png "Stitching-Menu-Grid-Sequence.png")
 
@@ -56,7 +56,7 @@ As result, the stitched images are stored in the output folder:
 Alignment
 ---------
 
-For the alignment of the stitched slices we will use the plugin *Register Virtual Stack Slices*, under {% include bc content='Plugins | Registration'%}:
+For the alignment of the stitched slices we will use the plugin *Register Virtual Stack Slices*, under {% include bc path='Plugins | Registration'%}:
 
 ![](/media/Screenshot-RVSS-Menu.png "Screenshot-RVSS-Menu.png")