Edit page History How do I edit this website?

Linking

This page demonstrates how to link to certain special classes of external content.

GitHub

Examples

Use path to link to a file off the repository root:

Code

{% include github path='WELCOME.md' %}

Result

on GitHub

Use source to link to a source file within the repository’s src/main/java subtree:

Code

{% include github source='net/imagej/ImageJ.java' %}

Result

on GitHub

Use org and repo to link to a different repository than imagej/imagej:

Code

{% include github org='fiji' repo='TrackMate' path='README.md' %}

Result

on GitHub

You can give just a repo (or just an org), and it will be used for both org and repo:

Code

{% include github repo='fiji'
  path='plugins/Examples/Fiji_Cube.ijm' %}

Result

on GitHub

If you give neither a path nor a source then it links to the repository as a whole:

Code

{% include github repo='fiji' %}

Result

on GitHub

Use tag to specify a tag (rather than master):

Code

{% include github tag='imagej-2.0.0-beta-7.9'
  path='app/src/test/java/imagej/debug/TypeHierarchy.java' %}

Result

on GitHub

Specifying tag alone links to the tag description:

Code

{% include github tag='imagej-2.0.0-rc-44' %}

Result

on GitHub

Use commit to specify a commit hash:

Code

{% include github
  commit='7a10880d485a13fc449d84c7e2eca3e1481064ee'
  label='imagej@7a10880d' %}

Result

imagej@7a10880d

Use issue or pr to specify an issue or PR number:

Code

{% include github issue='83' label='imagej#83' %}
or {% include github pr='88' label='imagej#88' %}

Result

imagej#83 or imagej#88

Use label to override the label:

Code

{% include github repo='fiji'
  path='plugins/Examples/Fiji_Logo_3D.js'
  label='Fiji...in 3D!' %}

Result

Fiji…in 3D!

Wikipedia

Code

Check out the
{% include wikipedia title="ImageJ" %}
article on Wikipedia!

Result

Check out the ImageJ article on Wikipedia!

Maven

Code

The Maven artifact for ImageJ as a whole is
{% include maven g='net.imagej' a='imagej' v='2.0.0' %}

Result

The Maven artifact for ImageJ as a whole is net.imagej:imagej:2.0.0

Javadoc

Examples

Code

See also the
{% include javadoc project="SciJava" %}
javadocs.

Result

See also the

SciJava javadocs.

Code

See also the
{% include javadoc
  project="ImageJ1"
  package="ij.process"
  class="ImageProcessor" %}
class.

Result

See also the

ImageProcessor class.

Code

See also the
{% include javadoc
  project="SciJava"
  package="org.scijava.module"
  class="ModuleService"
  anchor="getModules()" %}
method.

Result

See also the

ModuleService#getModules() method.

Code

See also the
{% include javadoc package="net.imagej.ops"
  class="package-summary" label="ImageJ Ops" %}
javadocs.

Result

See also the

ImageJ Ops javadocs.