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

Linking

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

The following liquid code:

{% include link-banner url='https://forum.image.sc/' %}

produces:

https://forum.image.sc/

GitHub

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

Code

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

Result

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

Code

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

Result

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

Code

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

Result

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' branch='master'
  path='plugins/Examples/Fiji_Cube.ijm' %}

Result

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

Code

{% include github repo='fiji' %}

Result

Use branch or tag to specify a branch or tag (rather than main):

Code

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

Result

Specifying tag alone links to the tag description:

Code

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

Result

Use commit to specify a commit hash:

Code

{% include github
  commit='7a10880d485a13fc449d84c7e2eca3e1481064ee' %}

Result

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

Code

{% include github issue=83 %}
or {% include github pr=88 %}

Result

Use label to override the label:

Code

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

Result

Javadoc

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.

Matlab

Code

Matlab has an {% include matlab path='ref' function='axis' %} function.

Result

Matlab has an axis function.

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

Scholar

Code

Check out {% include scholar cluster='8490320759898335020' label='NIH Image to ImageJ' %}!

Result

Check out NIH Image to ImageJ!

Code

Check out NIH Image to ImageJ {% include scholar cluster='8490320759898335020'%}!

Result

Check out NIH Image to ImageJ on Google Scholar!

Wikipedia

Code

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

Result

Check out the ImageJ article on Wikipedia!