Update built in documentation system

This commit is contained in:
Alexander Rosenberg 2024-09-15 00:33:07 -07:00
parent d76fda9bfd
commit 67ad3bf024
Signed by: Zander671
GPG Key ID: 5FD0394ADBD72730
8 changed files with 33 additions and 23 deletions

View File

@ -12,9 +12,6 @@ public class Start {
public static final String CURATOR_VERSION = "1.0"; public static final String CURATOR_VERSION = "1.0";
public static void main(String[] args) { public static void main(String[] args) {
// TODO debug
System.setProperty("sun.java2d.uiScale", "2");
registerSecretsFactories(); registerSecretsFactories();
SwingUtilities.invokeLater(() -> new LibrarySelectFrame(args)); SwingUtilities.invokeLater(() -> new LibrarySelectFrame(args));
} }

View File

@ -70,7 +70,7 @@ public class LibraryCreateDialog extends JDialog {
passwordLabel = new JLabel("Password:"); passwordLabel = new JLabel("Password:");
passwordField = new JPasswordField(10); passwordField = new JPasswordField(10);
ftpModeLabel = new JLabel("FTP Mode:"); ftpModeLabel = new JLabel("FTP Mode:");
ftpModeCombo = new JComboBox<String>(new String[] { "Active", "Passive" }); ftpModeCombo = new JComboBox<String>(new String[] { "Passive", "Active" });
defaultPathCheck = new JCheckBox("Use default library location"); defaultPathCheck = new JCheckBox("Use default library location");
defaultPathCheck.setSelected(true); defaultPathCheck.setSelected(true);
pathLabel = new JLabel("Library Path:"); pathLabel = new JLabel("Library Path:");

View File

@ -78,8 +78,8 @@ public class LibraryEditDialog extends JDialog {
passwordField = new JPasswordField(10); passwordField = new JPasswordField(10);
passwordField.setText(password); passwordField.setText(password);
ftpModeLabel = new JLabel("FTP Mode:"); ftpModeLabel = new JLabel("FTP Mode:");
ftpModeCombo = new JComboBox<String>(new String[] { "Active", "Passive" }); ftpModeCombo = new JComboBox<String>(new String[] { "Passive", "Active" });
ftpModeCombo.setSelectedIndex(passiveMode ? 1 : 0); ftpModeCombo.setSelectedIndex(passiveMode ? 0 : 1);
defaultPathCheck = new JCheckBox("Use default library location"); defaultPathCheck = new JCheckBox("Use default library location");
pathLabel = new JLabel("Library Path:"); pathLabel = new JLabel("Library Path:");
pathField = new FileChooserField(10, file, new File(LibrarySelectFrame.DEFAULT_LIBRARY_PATH)); pathField = new FileChooserField(10, file, new File(LibrarySelectFrame.DEFAULT_LIBRARY_PATH));

View File

@ -62,7 +62,7 @@ public class LibraryImportDialog extends JDialog {
passwordLabel = new JLabel("Password:"); passwordLabel = new JLabel("Password:");
passwordField = new JPasswordField(10); passwordField = new JPasswordField(10);
ftpModeLabel = new JLabel("FTP Mode:"); ftpModeLabel = new JLabel("FTP Mode:");
ftpModeCombo = new JComboBox<String>(new String[] { "Active", "Passive" }); ftpModeCombo = new JComboBox<String>(new String[] { "Passive", "Active" });
fileLabel = new JLabel("Source:"); fileLabel = new JLabel("Source:");
fileField = new FileChooserField(10); fileField = new FileChooserField(10);
fileField.getChooser().setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY); fileField.getChooser().setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.3 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -4,18 +4,22 @@
<h1 style="text-align: center">Local Library Settings</h1> <h1 style="text-align: center">Local Library Settings</h1>
<h2>Overview</h2> <h2>Overview</h2>
<p> <p>
These dialogs create, import or alter the settings of libraries. These settings are primarily These dialogs create, import or alter the settings of libraries. These
for use of Curator and will not affect the Art Museum website. settings are primarily for use of Curator and will not affect the Art
Museum website.
</p> </p>
<p> <p>
<b>Local vs Remote Library</b> <b>Local vs Remote Library</b>
<br> <br>
Remore libraries are instances of the Art Museum website. They are connected to by FTP. Remore libraries are instances of the Art Museum website. They are
Any changes made to them will be reflected in their respective Art Museum instance. connected to by FTP. Any changes made to them will be reflected in their
respective Art Museum instance.
<br> <br>
Local libraries, or caches, are instances of libraries located on your computer. When you connect Local libraries, or caches, are instances of libraries located on your
to a remote library, a local library is automatically created and sync with its remote counterpart. computer. When you connect to a remote library, a local library is
Every time you connect to a remote library, its local counterpart is updated in this way. automatically created and sync with its remote counterpart. Every time
you connect to a remote library, its local counterpart is updated in this
way.
</p> </p>
<img width="500" src="library-create-dialog.png"></img> <img width="500" src="library-create-dialog.png"></img>
<p>The library creation and remote import dialog.</p> <p>The library creation and remote import dialog.</p>
@ -29,16 +33,25 @@
<p>The local library import dialog.</p> <p>The local library import dialog.</p>
<h2>Options</h2> <h2>Options</h2>
<ul> <ul>
<li><b>Name</b>: library name in the select dialog. Does not affect website.</li> <li><b>Name</b>: library name in the select dialog. Does not affect
<li><b>URL</b>: url in the select dialog. Can be blank. Does not affect the website.</li> website.</li>
<li><b>FTP</b>: FTP server to connect to. Must be in the format of 'ftp://hostname:port/path/to/library'. <li><b>URL</b>: url in the select dialog. Can be blank. Does not affect
Protocol can also be FTPS by replacing 'ftp://' with 'ftps://'.</li> the website.</li>
<li><b>Username & Password</b>: username and password to use to connect to FTP server.</li> <li><b>FTP</b>: FTP server to connect to. Must be in the format of
<li><b>Library Location (Source)</b>: location to save caches in. If 'User default library location' 'ftp://hostname:port/path/to/library'. Encryption is supported via
is checked, it will be stored in the directory set in the global settings menu. FTPS. To enable it, replace 'ftp://' with 'ftps://'.</li>
<li><b>Username & Password</b>: username and password to use to connect to
FTP server.</li>
<li><b>FTP Mode</b>: Whether to use active (PORT) or passive (PASV) FTP
mode. If you are unsure, it's best to start with passive and change to
active if you are having trouble connecting.</li>
<li><b>Library Location (Source)</b>: location to save caches in. If 'User
default library location' is checked, it will be stored in the directory
set in the global settings menu.
<a href="help:Libraries/Global Settings">See: Global Settings</a></li> <a href="help:Libraries/Global Settings">See: Global Settings</a></li>
<li><b>Clear Cahce</b>: clear library cahce. This does <b>NOT</b> affect the remote library. It only <li><b>Clear Cahce</b>: clear library cahce. This does <b>NOT</b> affect
clears the local cache. Doing this will cause a full re-download of the remote library next time it is the remote library. It only clears the local cache. Doing this will
cause a full re-download of the remote library next time it is
oppened.</li> oppened.</li>
</ul> </ul>
</body> </body>