Page history Edit this page How do I edit this website?

Editing the Wiki

This page explains how to write and edit wiki pages. The simplest way to create or modify a page is using GitHub’s online file editor. Each page has an “Edit page” link at the top right with a direct link to this interface.

Advanced users can make edits via a local clone of the site repository; see the advanced editing guide for setup instructions.

Creating a new page

Let’s dive in to how to create a new page on the site. If you are looking to edit an existing page, skip to adding and editing page content below.

  1. Navigate to an appropriate sub-directory of the pages section of the repository. For example, if you are creating a page about a plugin, you would go to _pages/plugins/.

  2. Click Add file then Create new file from the drop-down:

    editing/create-page-etw

  3. Add a name for your file. Note: this is not the page title; the page title will be applied in the next section, front matter. File names should be:

    • all lower case
    • use the file extension .md
    • avoid symbols and spaces, and separate words using dashes (-):

    editing/name-your-file

Front matter

Every page begins with a block of front matter: a sequence of parameters that configure your page. Without the front matter, your page will not render correctly. The following table lists front matter fields you can use:

Field Purpose
title The title of your page. (Required)
description A short description of your page. Also used for the site’s search engine. When omitted, the first sentence of the page content is used.
section Main menu section that should be open when this page first loads, if any. Nested sections to expand should be separated by colons (:). For example, this page’s section is Contribute:Editing the Wiki.
categories For pages describing extensions (e.g. a plugin, script, or update site) of ImageJ: a comma-separated list of categories, enclosed in square brackets ([ and ]). Pages with categories appear in the List of extensions. For example, [Segmentation, Registration] would put your page in the Segmentation and Registration categories.
statbox* A collection of individual fields that are used to populate the “Vital statistics” sidebar; see this comment for a list. Including at least one of these fields will cause the statbox to appear; otherwise, there will be no statbox for the page.
(*note there is no field called “statbox”)
icon A link (internal or external) to an icon that will be used for the page across the wiki, e.g. in the list of extensions or search bar results.
project Used to identify project affiliation. See the list of available projects
nav-links Adds a top navigation bar for related pages. See the Navigation guide for examples.

Below is a minimal example front matter block. You can copy and paste this code into the editor of a new page (see above).

Replace My Awesome Page with the title for the new page.

---
title: My Awesome Page
---

Adding + editing page content

This section covers how to populate the content of your page.

Markdown

Markdown is plain-text syntax formatting, allowing you to easily and cleanly modify text with italics, bold, ordered or bulleted lists, etc. This wiki, as a Jekyll site, uses kramdown. A quick-reference can be found here, and a general Jekyll support reference here. Also helpful is GitHub Flavored Markdown (GFM) guide found here.

Here are some common kinds of text formatting:

Formatting Markup
italic text *italic text*
bold text **bold text**
bold and italic text ***bold and italic text***
fixed width text/code `fixed width text/code`
struck-out text ~~struck-out text~~
Hyperlink [Hyperlink](https://example.com/)
red text <span style="color: red">red text</span>

Note that the last example, colored text, is not really Markdown, but rather plain HTML. However, Markdown does not have a syntax for changing text color, and it supports mixing in HTML, so you can use the technique above if you need text in different colors.

Here are some common image uses:

Image Markup
Alt text ![Alt text](/media/icons/fiji.svg)
External image ![External image](https://fiji.sc/site/logo.png){:width="64px"}

Note that the last example includes inline styling, which is kramdown-specific.

Certain kinds of structures have dedicated pages of this guide:

Liquid

On top of Markdown, the site uses a templating language called Liquid to make page editing more convenient than with Markdown alone. Liquid tags look like {% ... %} or {{ ... }}. Many pages on this site use Liquid to invoke functions called includes, which enable insertion of images, figures, notices, and more. (Think of this as: “I would like to include an image”.) Here are a couple of examples:

Markup Result
{% include icon name="imagej" %} imagej
{% include person id="rasband" %} Wayne Rasband

Available includes

The following tables list all of this site’s general-purpose includes:

Citations and footnotes

Include Purpose
citation Insert a citation
testimonial Insert a personal quote

Linking

Include Purpose
link-banner Insert a large, obvious link
github Link to a resource on GitHub
javadoc Link to a javadoc resource
matlab Link to MATLAB documentation
maven Link to Maven artifacts
person Link to a person’s user page
person-list Link to a list of user pages
scholar Link to an article on Google Scholar
wikipedia Link to a Wikipedia page

Symbols

Include Purpose
bc Insert a menu breadcrumb
button Insert a button
key Insert a keyboard shortcut
icon Insert an icon

Media

Include Purpose
img Insert an image
gallery Insert an image gallery
video Embed a video
spreadsheet Embed a spreadsheet

Notices

Include Purpose
notice Insert an informational notice banner
aside Float a right sidebar with commentary

Source code

Include Purpose
code Embed a code snippet from GitHub

Miscellaneous

Include Purpose
quiz Insert a Q&A with hidden answer
timeline Insert a horizontal timeline
tooltip Add a tooltip appearing on mouseover
echo For debugging

MARKED FOR REMOVAL

Include What needs to happen
thumbnail Merge with img include
info-box Delete after migrating to statbox
clear Delete after purging all floats