| Age | Commit message (Collapse) | Author |
|---|
|
|
|
Split up the setVersionPickerOptions() function to create the
admonition elements before the versions.json list was fetched. This
will avoid the page jumping around when the GetJSON() promise takes
some time to resolve.
Clean up some code styling along the way, using var instead of let and
direct element attribute access instead of setAttributes().
* Hide only the content, not the box itself.
* Center text in box.
* Restore behavior of hiding the whole note when unavailable.
|
|
* Add a header note allowing to pick a specific version.
Install a handler for the DOMContentLoaded event from the existing
version_redirect.js script, which creates and inserts the actual note
box and selector at the top of the "document" div. This allows to
keep all the historically generated HTML files untouched, except for
including the script.
* Fix JS warnings about not well-formed XML.
Using the $.getJSON() method apparently fails to apply the correct
MIME type, trying to parse the script as HTML / XML and giving an
error message. Especially Firefox seems to be affected by this.
Overriding the MIME type explicitly before each request silences the
error message. Taken from:
https://stackoverflow.com/questions/2618959/not-well-formed-warning-when-loading-client-side-json-in-firefox-via-jquery-aj
* Keep history when using version picker.
Using the browser's back button should allow to go back to the
previously displayed version. It doesn't make sense for URL-parameter
based redirects, though, so keep it off for that case.
|
|
* _ext: Add custom Sphinx extension for configuration cross-refs.
Implement a Sphinx extension with its own domain "stconf" and the
contained custom directive .. stconf:option: and role :stconf:opt:
They work quite similar to the standard Sphinx mechanisms for
documenting functions, classes, etc. including the usual
cross-referencing syntax. The directive removes the first part
separated by a dot and handles it as a "section" to disambiguate
option names such as "id".
Add the plugin to the Sphinx config file.
* users/config: Use custom directive for documented options.
Apply the "option" directive instead of keeping entries in a simple
RST "definition list". Prefix all elements with the "section" name,
namely the parent XML element. Blank lines need to be inserted
after each directive before the actual description.
Set the default domain for this file to keep the directive and role
names short.
* users/config: Replace cross-references by config option links.
Remove old labels just used for a link target.
* _ext/syncthing_config: Implement :mandatory: option.
Allow an (RST directive) option named :mandatory: for the
ConfigOptionDirective class. It gets parsed into a nice annotation
element with different styling. A text argument can be given which is
reflected in the annotation.
Apply to config elements where the description indicates something is
mandatory.
* users/config: Fix indentation within option descriptions.
The references to other documents should be part of the description,
not interleaved with the list at top level.
* users/config: Cross-reference by doc instead of extra label.
Replace the .. _label / :ref: construct with a direct document
reference. The same could be done for many more documents.
* users/config: Add missing element descriptions.
* filesystemType (new advanced option page)
* ignorePerms
* autoNormalize (link to advanced)
* encryptionPassword (link to untrusted)
* pullerMaxPendingKiB (extended wording)
* ignoreDelete (link to advanced)
* disableFsync (link to advanced)
* copyRangeMethod (link to advanced)
* caseSensitiveFS (link to advanced)
* allowedNetwork (link to advanced)
* autoAcceptFolders (link to advanced)
* untrusted (link to untrusted)
* insecureSkipHostcheck
* insecureAllowFrameLoading
* <ldap> section (link to ldap)
* searchBaseDN
* searchFilter
* maxFolderConcurrency (link to advanced)
* crashReportingURL (link to users/crashrep)
* crashReportingEnabled (link to users/crashrep)
* databaseTuning (link to advanced)
* maxConcurrentIncomingRequestKiB
* connectionLimitEnough (link to advanced)
* connectionLimitMax (link to advanced)
* insecureAllowOldTLSVersions (link to advanced)
* junctionsAsDirs
* announceLANAddresses
* sendFullIndexOnUpgrade
* stunKeepaliveStartS (replaces stunKeepaliveSeconds)
* stunKeepaliveMinS (replaces stunKeepaliveSeconds)
* featureFlag
Remove obsolete "pullers" element from the folder section.
Adjust description of free space units to point at the "unit=" XML
attribute.
* _static: Add custom CSS directive for padding below config options.
* faq/troubleshooting: Fix code formatting and x-ref option.
* users/config: Properly mark literals for option values.
Add missing link for skipIntroductionRemovals option.
* users/config: Two blank lines before headline.
Improve readability of raw RST version by larger gap before headlines.
* users/config: Specify default pull order.
* users/config: Document folder type setting "receiveencrypted".
Add cross-references from / to the "untrusted" chapter. Extend the
description of device.untrusted to mention receive-encrypted folders.
* users/faq: Link to folder.junctionsAsDirs.
|
|
Include a custom JavaScript snippet in the built HTML version. It
checks the ?version=... query parameter and heuristically finds a best
match among the deployed versions list in JSON format.
If a match is found, the browser URL is reconstructed to prepend the
matched version string as a path component. If the previous first
path component matches a version tag from the list, that is removed
first. The query parameters get discarded, and the fragment
identifier (#anchor) appended again. This changed URL is used for a
silent redirect.
The version matching heuristic accepts any version string starting
with a complete known version tag, checking numerically higher ones
first. For example if v0.12.10 matches first, v0.12.1 is not even
considered anymore. Incomplete matches are accepted as long as they
only differ after the last dot: v0.13.10 applies to any
v0.13.* (higher or lower) as long as there is no better, direct match.
Any other string in the query parameter leads to the same path with
any known version string in the top-level component removed. That
should be the default, fall-back version.
|
|
|
|
|
|
Rough section division, local ToC
|
|
The default theme removes margins after last paragraph inside a list
item, but this removes any space between two adjacent list items. Thus,
override the default CSS keeping the default margin of 1em, and only
remove the margin in the last list item instead.
Signed-off-by: Tomasz Wilczyński <twilczynski@naver.com>
|
|
Use FileOptimizer (nikkhokkho.sourceforge.io/static.php?page=FileOptimizer)
to losslessly compress all images without reducing their quality.
Signed-off-by: Tomasz Wilczyński <twilczynski@naver.com>
|
|
|
|
|
|
|
|
I think our current one is outdated and ugly. It's a taste call, I'm not
going to ask or tell anyone. So sue me.
|
|
|
|
GitHub-Pull-Request: https://github.com/syncthing/docs/pull/197
|
|
|
|
|
|
|
|
|
|
|
|
Although there is a warning about not being an *.ico, I think the
warning can be safely ignored. Modern browsers support pngs well.
|
|
Increasing the font size is *not* useful due to a couple of reasons:
- It breaks the visual seperation between the headlines. It is very
hard to determine the headline levels when the font size is that big.
- It breaks the definition lists which are useful for manpages.
- It extends the line width to an unnatural value. It is not narrow
any more, but it is also not big. It just looks a bit odd.
- The regular font (on linux) renders as almost a light bold type. It
generates a "Comic Sans" experience. That does not look
professional.
Since I am not a designer and I don't know how to fix these problems in
the right way, I think the best solution is switching back to the very
sane defaults.
|
|
|
|
|
|
|
|
|
|
|
