Skip to content

Commit 25c07b3

Browse files
authored
Expand platform-specific file directions
1 parent 483f172 commit 25c07b3

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

_pages/update-sites/setup.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,19 +111,25 @@ If this info is missing, see [Specifying your site](#specifying-your-site). Once
111111

112112
### Prepare your files for upload
113113

114-
Click on the {% include button label="Advanced Mode" %} button and set the view options to see your plugins:
114+
The general principle of populating an update site is to add the files of interest to your local Fiji installation, building your desired working state, then synchronizing to the remote update site.
115115

116-
- If your have never uploaded your plugins, select *View local-only files*
116+
Note that there are several guidelines for where these files should be placed, based on their file type:
117117

118-
**For .ijm macros**, the files should be in an appropriately named *plugins* subfolder. Their parent folder will become the entry name in the `Plugins` menu.
118+
* **.jar libraries**: for files used by other libraries or plugins, but not directly present e.g. in the `Plugins` menu, they go in the *jars* folder (or subfolder). If the file is platform-specific, it goes in the corresponding platform subdirectory of the *jars* folder (e.g. *jars/win64*).
119+
* **.jar plugins**: new additions to the `Plugins` menu belong in the *plugins* folder (or subfolder). Don't forget to include an underscore (`_`) in the name!
120+
* **.dll, .dylib, etc...**: native libraries belong in a platform-specific subfolder of the *lib* directory (e.g. *lib/win64*).
121+
* **.ijm macros**: the files should be in the *plugins* folder or an appropriately named subfolder thereof. Their parent folder will become the entry name in the `Plugins` menu.
122+
* **.py scripts**: they can be either in the *jars/Lib* or *scripts* folder (or any subfolder).
119123

120-
**For .py scripts**, they can be either in the *Jars/Lib* or *scripts* folder (or any subfolder).
124+
{% include notice icon="info" content='If you are uploading platform-specific files you will also need to [edit the metadata](#editing-metadata)!' %}
121125

122-
Out of those folder, the updater might not see them.
126+
Out of those folders, the updater might not see them, or they may not be loaded correctly.
123127

124-
- If you are uploading new versions of your plugins, select *View locally modified files only*
128+
To see your plugin(s) or file(s) back in the updater, click the {% include button label="Advanced Mode" %} button and set the view options:
129+
- If your have never uploaded your plugins, select *View local-only files*
130+
- If you are uploading new versions of your plugins, select *View locally modified files only*
125131

126-
In this case, the plugin we'll be uploading is contained in *A\_Jolly\_Useful\_Plugin.jar*.
132+
In this example, the plugin we'll be uploading is contained in *A\_Jolly\_Useful\_Plugin.jar*.
127133

128134
Select the file to upload, click under the *Stats/Action* column, or right-click (on macOS, {% include key keys='Ctrl|Left Click' %}) in any column, for the context menu and select *Upload to <update site name>*.
129135

@@ -133,7 +139,7 @@ Select the file to upload, click under the *Stats/Action* column, or right-click
133139

134140
### Editing Metadata
135141

136-
When a file is selected in Advanced MOde, a *Details* panel becomes available. This allows manual editing of important metadata.
142+
When a file is selected in Advanced Mode, a *Details* panel becomes available. This allows manual editing of important metadata.
137143

138144
<img src="/media/update-sites/how-to-setup-a-plugin-distribution-site-15.jpg" width="770"/>
139145

0 commit comments

Comments
 (0)