You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _pages/update-sites/setup.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,19 +111,25 @@ If this info is missing, see [Specifying your site](#specifying-your-site). Once
111
111
112
112
### Prepare your files for upload
113
113
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.
115
115
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:
117
117
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).
119
123
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)!' %}
121
125
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.
123
127
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*
125
131
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*.
127
133
128
134
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>*.
129
135
@@ -133,7 +139,7 @@ Select the file to upload, click under the *Stats/Action* column, or right-click
133
139
134
140
### Editing Metadata
135
141
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.
0 commit comments