update citation tool documentation (#199)

CellProfiler · Jun 2, 2023 · 42044b9 · 42044b9
1 parent 1da192b
commit 42044b9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/documentation/CP-plugins-documentation/citing.md b/documentation/CP-plugins-documentation/citing.md
@@ -5,10 +5,10 @@ If using CellProfiler Plugins in a pipeline used in a publication, please cite o
 ENTER CITATION
 
 Additionally, some plugins require citation themselves if used.
-You can determine which plugins require citation by reading the Help information for each plugin, accessible through CellProfiler, or by using the Citation generator built into CellProfiler (since VERSION).
+You can determine which plugins require citation by reading the Help information for each plugin, accessible through CellProfiler, or by using the Citation generator built into CellProfiler (since CellProfiler 5).
 
-To use CellProfiler's citation generator, load your pipeline into CellProfiler.
-Navigate to File => Export => Citation.
+![alt text](images/citation.png)
+Figure 1: How to use the citation tool. To use CellProfiler's citation generator, load your pipeline into CellProfiler (A). Navigate to File => Export => Citation (B). If any module in your pipeline is currently disabled, a citation for that module will still be generated but it will include a `disabled` tag. 
 
 Please note that many CellProfiler modules (including plugins) provide references that offer further information/background about the processing happening within the module.
 You may wish to read the references and cite any that upon which your analyses are particularly dependent.

diff --git a/documentation/CP-plugins-documentation/contributing_plugins.md b/documentation/CP-plugins-documentation/contributing_plugins.md
@@ -27,6 +27,6 @@ If you would like to update a currently deprecated plugin, we encourage you to r
 
 ## Having your plugin cited
 
-While we cannot guarantee that users will cite your plugin, we have introduced a Citation generator into CellProfiler v? that scans all modules in a user's pipeline and generators a citation file for them that includes citation information for any modules (including plugins) that have specific citation information in them.
+While we cannot guarantee that users will cite your plugin, we have introduced a Citation generator into CellProfiler (currently available in CellProfiler from source and will be in CellProfiler 5) that scans all modules in a user's pipeline and generates a citation file for them that includes citation information for any modules (including plugins) that have specific citation information in them.
 
 See [Citing Plugins](citing.md) for information on citing CellProfiler Plugins.
diff --git a/documentation/CP-plugins-documentation/images/citation.png b/documentation/CP-plugins-documentation/images/citation.png