Skip to content

Commit

Permalink
Make sidebar work for ImgLib2 and BDV sections
Browse files Browse the repository at this point in the history
* And unify the two toplevel ImgLib2 pages into one.
* And move the toplevel BDV page into a dedicated subdirectory.
  • Loading branch information
ctrueden committed Apr 21, 2024
1 parent ceee113 commit 7bbbdc7
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 77 deletions.
38 changes: 22 additions & 16 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ website:
navbar:
right:
- text: "ImgLib2"
href: "imglib2.qmd"
href: "imglib2"
- text: "BDV"
href: "bdv.qmd"
href: "bdv"
- text: Blog
href: blog.qmd
- text: Resources
Expand Down Expand Up @@ -45,20 +45,26 @@ website:
open-graph: true
repo-url: https://github.com/imglib/imglib2-www
site-url: https://imglib.github.io/imglib2-www
sidebar:
collapse-level: 2
style: "floating"
search: false
contents:
- section: "ImgLib2"
contents: ImageJ_Documentation/imglib2/*
pinned: false
- section: "ImgLib 'Deprecated' "
contents: ImageJ_Documentation/imglib1/*
pinned: false
tools:
- icon: github
href: https://github.com/imglib/imglib2
# Sidebar configuration using Hybrid Navigation, as described at:
# https://quarto.org/docs/websites/website-navigation.html#hybrid-navigation
# The intent is for the ImgLib2 section of the site to show all ImgLib2
# articles in a dedicated sidebar, and similarly, for the BigDataViewer
# section of the site to show all BigDataViewer articles in its sidebar.
sidebar:
- title: "BigDataViewer"
style: "docked"
background: light
collapse-level: 2
contents:
- bdv/index.qmd
- auto: "bdv/*"
- title: "ImgLib2"
style: "docked"
background: light
collapse-level: 2
contents:
- imglib2/index.qmd
- auto: "imglib2/*"
sidebar: false

format:
Expand Down
3 changes: 2 additions & 1 deletion bdv.qmd → bdv/index.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "BigDataViewer"
image: logos/bdv.png
image: ../logos/bdv.png
about:
template: solana
links:
Expand All @@ -10,6 +10,7 @@ about:
format:
html:
code-tools: false
sidebar: true
---

The BigDataViewer is a re-slicing browser for terabyte-sized multi-view image sequences.
Expand Down
56 changes: 0 additions & 56 deletions imglib2/index.md

This file was deleted.

45 changes: 43 additions & 2 deletions imglib2.qmd → imglib2/index.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "ImgLib2"
image: logos/imglib2.png
image: ../logos/imglib2.png
sidebar: true
format:
html:
Expand All @@ -15,7 +15,6 @@ about:
- icon: github
text: Github
href: https://github.com/imglib

---

ImgLib2 is a general-purpose, multidimensional image and data processing library.
Expand Down Expand Up @@ -75,3 +74,45 @@ BdvFunctions.show(
BdvOptions.options().is2D()).setDisplayRange(0, 64);
```

## Resources

- [ImgLib2 paper](http://bioinformatics.oxfordjournals.org/content/28/22/3009.full)
- [ImgLib2 Documentation](/libs/imglib2/documentation)
- [ImgLib2 Examples](/libs/imglib2/examples)
- [ImgLib2 Blog](https://imglib.github.io/imglib2-blog/)
- [Image.sc forum](https://forum.image.sc/tag/imglib2)
- {% include javadoc project='ImgLib2' %} javadoc
- [How To Migrate Code From ImgLib To ImgLib2](/libs/imglib2/migrate-from-imglib1)
- ["Introduction to ImgLib2"](/libs/imglib2/workshop-introductory) workshop
- ["Advanced Programming with ImgLib2"](/libs/imglib2/workshop-advanced) workshop
- ["I2K 2020 Introductory ImgLib2"](https://github.com/saalfeldlab/i2k2020-imglib2-intro) workshop
- ["I2K 2020 Advanced ImgLib2"](https://github.com/saalfeldlab/i2k2020-imglib2-advanced) workshop

## Source code

You can find the source {% include github org='imglib' repo='imglib2' %}.

There is also a [continuous integration](/develop/ci) system that builds ImgLib2 [every time the code changes](https://github.com/imglib/imglib2/actions).

## ImgLib2 vs. ImgLib1

[ImgLib1](/libs/imglib1) is the previous incarnation of the library. We encourage developers to use ImgLib2 instead, and [migrate existing ImgLib1 programs to ImgLib2](/libs/imglib2/migrate-from-imglib1) whenever possible.

For an explanation of how ImgLib2 has changed from ImgLib1, see the [Changes from ImgLib1 to ImgLib2](/libs/imglib2/changes-from-imglib1) page.

See the [How To Migrate Code From ImgLib To ImgLib2](/libs/imglib2/migrate-from-imglib1) page for details on how to update your ImgLib1-based code to use ImgLib2.

## API Version History

A history of API changes is available at: [https://abi-laboratory.pro/java/tracker/timeline/imglib2/](https://abi-laboratory.pro/java/tracker/timeline/imglib2/)

## Other links

- [ImgLib2 development discussion](/libs/imglib2/discussion)
- [ImgLib2 performance benchmarks](/libs/imglib2/benchmarks)
- [ImageJ2](/software/imagej2) uses ImgLib2 as its core data model

## Publication

Pietzsch, T., Preibisch, S., Tomančák, P., & Saalfeld, S. (2012). [ImgLib2—generic image processing in Java](http://bioinformatics.oxfordjournals.org/content/28/22/3009.full). Bioinformatics, 28(22), 3009-3011.

4 changes: 2 additions & 2 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ format:
sidebar: false
---

[![](logos/imglib2.png)](imglib2.qmd){fig-align="left" width=40% height=40%}
[![](logos/bdv.png)](bdv.qmd){fig-align="right" width=40% height=40%}
[![](logos/imglib2.png)](imglib2){fig-align="left" width=40% height=40%}
[![](logos/bdv.png)](bdv){fig-align="right" width=40% height=40%}



Expand Down

0 comments on commit 7bbbdc7

Please sign in to comment.