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: docs/developer_api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -688,7 +688,7 @@ Response:
688
688
* 4 - File failed to import
689
689
* 7 - File vetoed
690
690
691
-
A file 'veto' is caused by the file import options (which in this case is the 'quiet' set under the client's _options->importing_) stopping the file due to its resolution or minimum file size rules, etc...
691
+
A file 'veto' (aka 'ignored') is caused by the file import options (which in this case is the 'client api' set under the client's _options->import options_) stopping the file due to its resolution or minimum file size rules, etc...
692
692
693
693
'hash' is the file's SHA256 hash in hexadecimal, and 'note' is any additional human-readable text appropriate to the file status that you may recognise from hydrus's normal import workflow. For an outright import error, it will be a summary of the exception that you can present to the user, and a new field `traceback` will have the full trace for debugging purposes.
Copy file name to clipboardExpand all lines: docs/getting_started_downloading.md
+10-54Lines changed: 10 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,12 @@ There are several different downloader types, each with its own purpose:
36
36
**Simple downloader**
37
37
: Advanced. Intended for simple one-off jobs with a single simple parsing rule, like 'get all the linked images from this page'.
38
38
39
+
39
40
### Gallery download
41
+
42
+
!!! warning
43
+
The file limit and import options on the upper panel of a gallery or watcher page, if changed, will only apply to **new** queries. If you want to change the options for an existing queue, either do so on its highlight panel below or use the 'set options to queries' button.
44
+
40
45

41
46
42
47
The gallery page can download from multiple sources at the same time. Each entry in the list represents a basic combination of two things:
@@ -111,70 +116,21 @@ The **simple downloader** will do very simple parsing for unusual jobs. If you w
111
116
112
117
## Import options
113
118
114
-
!!! note "This is changing!"
115
-
Hey, this whole system is being migrated soon. The bulky file/tag/note import options are being split up, and a favourites/template system is being introduced.
116
-
117
-
A draft of the help for this new options system is [here](getting_started_import_options.md).
118
-
119
-
Every importer in Hydrus has some 'import options' that change what is allowed, what is blacklisted, and whether tags or notes should be saved.
120
-
121
-
In previous versions these were split into completely different windows called `file import options` and `tag import options` so if you see those anywhere, this is what they're talking about and not some hidden menu anywhere.
122
-
123
-
Importers that download from websites rely on a flexible 'defaults' system, so you do not have to set them up every time you start a new downloader. While you should play around with your import options, once you know what works for you, you should set that as the default under _network->downloaders->manage default import options_. You can set them for all file posts generally, all watchers, and for specific sites as well.
124
-
125
-
### File import options
126
-
This deals with the files being downloaded and what should happen to them. There's a few more tickboxes if you turn on advanced mode.
127
-
128
-

129
-
130
-
**pre-import checks**
131
-
: Pretty self-explanatory for the most part. If you want to redownload previously deleted files turning off `exclude previously deleted files` will have Hydrus ignore deletion status.
132
-
A few of the options have more information if you hover over them.
133
-
134
-
**import destinations**
135
-
: See [multiple file services](advanced_multiple_local_file_services.md), an advanced feature.
136
-
137
-
**post import actions**
138
-
: See the [files section on filtering](getting_started_files.md#inbox_and_archive) for the first option, the other two have information if you hover over them.
119
+
Every import in Hydrus operates under a flexible set of 'import options' that change what is allowed, what file properties or tags are blacklisted, and whether metadata like tags or notes should be saved. The defaults for this system are fine, but if you wish to read more, the full help is [here](getting_started_import_options.md).
139
120
140
121
### Tag Parsing
141
-
By default, hydrus now starts with a local tag domain called 'downloader tags' and it will parse (get) all the tags from normal gallery sites and put them in this service. You don't have to do anything, you will get some decent tags. As you use the client, you will figure out which tags you like and where you want them. On the downloader page, click `import options`:
142
122
143
-

144
-
145
-
146
-
This is an important dialog, although you will not need to use it much. It governs which tags are parsed and where they go. To keep things easy to manage, a new downloader will refer to the 'default' tag import options for a website, but for now let's set some values just for this downloader:
147
-
148
-

149
-
150
-
You can see that each tag service on your client has a separate section. If you add the PTR, that will get a new box too. A new client is set to _get all tags_ for 'downloader tags' service. Things can get much more complicated. Have a play around with the options here as you figure things out. Most of the controls have tooltips or longer explainers in sub-dialogs, so don't be afraid to try things.
151
-
152
-
It is easy to get tens of thousands of tags by downloading this way. Different sites offer different kinds and qualities of tags, and the client's downloaders (which were designed by me, the dev, or a user) may parse all or only some of them. Many users like to just get everything on offer, but others only ever want, say, `creator`, `series`, and `character` tags. Once you feel comfortable with tags, try clicking that 'adding: all tags' button, which will take you into hydrus's advanced 'tag filter', which allows you to select which of the incoming tags will be added.
153
-
154
-
The 'additional tags' adds some fixed personal tags to all files coming in--for instance, you might like to add 'this came from the xxxxx subscription' or 'process into favourites' to your 'my tags' so you can find those files again later. That little 'cog' icon button can also do some advanced things.
155
-
156
-
The blacklist button will let you skip downloading files that have certain tags, again using the tag filter, while the whitelist enables you to only allow files that have at least one of a set of tags.
157
-
158
-

159
-
160
-
!!! warning
161
-
The file limit and import options on the upper panel of a gallery or watcher page, if changed, will only apply to **new** queries. If you want to change the options for an existing queue, either do so on its highlight panel below or use the 'set options to queries' button.
123
+
By default, hydrus starts with a local tag domain called 'downloader tags' and it will parse (get) all the tags from normal gallery sites and put them in this service. You don't have to do anything, you will get some decent tags. As you use the client, you will figure out which tags you like and perhaps decide you want them to go to different areas. Revisit the import options help when you are ready to make decisions here.
162
124
163
125
#### Force Page Fetch
164
126
165
-
By default, hydrus will not revisit web pages or API endpoints for URLs it knows A) refer to one known file only, and B) that file is already in your database or has previously been deleted. The way it navigates this can be a complicated mix of hash and URL data, and in certain logical situations hydrus will determine its own records are untrustworthy and decide to check the source again. This saves bandwidth and time as you run successive queries that include the same results. You should not disable the capability for normal operation.
127
+
By default, hydrus will not revisit web pages or API endpoints for URLs it knows A) refer to one known file only, and B) that file is already in your database or has previously been deleted. This means if you run a normal download twice, hydrus will not fetch the tags that second time.
166
128
167
-
But if you mess up your tag import options somewhere and need to re-run a download with forced tag re-fetching, how to do it?
168
-
169
-
At the moment, this is in tag import options, the `force page fetch even if...` checkboxes. You can either set up a one-time downloader page with specific tag import options that check both of these checkboxes and then paste URLs in, or you can right-click a selection of thumbnails and have hydrus create the page for you under the _urls->force metadata refetch_ menu. Once you are done with the downloader page, delete it and do not use it for normal jobs--again, this method of downloading is inefficient and should not be used for repeating, long-term, or speculative jobs. Only use it to fill in specific holes.
129
+
If you mess up your tag import options the first time and need to re-run a download, right-click a selection of thumbnails and hit `urls->force metadata refetch`. This creates a new page with special Prefetch Import Options allowing for refetching the tags (while still skipping the actual file redownload)!
170
130
171
131
### Note Parsing
172
132
173
-
Hydrus also parses 'notes' from some sites. This is a young feature, and a little advanced at times, but it generally means the comments that artists leave on certain gallery sites, or something like a tweet text. Notes are editable by you and appear in a hovering window on the right side of the media viewer.
174
-
175
-

176
-
177
-
Most of the controls here ensure that successive parses do not duplicate existing notes. The default settings are fine for all normal purposes, and you can leave them alone unless you know you want something special (e.g. turning note parsing off completely).
133
+
Hydrus also parses 'notes' from some sites. This generally means the comments that artists leave on certain gallery sites, or something like a tweet text. Notes are editable by you and appear in a hovering window on the right side of the media viewer.
Copy file name to clipboardExpand all lines: docs/getting_started_installing.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,8 @@ I try to release a new version every Wednesday by 8pm EST and write an accompany
76
76
77
77
One user reports that Fedora might need `libxkbcommon` too.
78
78
79
+
**One user had a related error that caused a program crash any time he pressed any key. This was an _incompatibility_ with the `libxkbcommon` bundled with the built release. The solution here--and with any other severe crashes than can be traced to a specific bundled .so file--is to run from source.**
80
+
79
81
80
82
* Get the .tag.gz. Extract it somewhere useful and create shortcuts to 'hydrus_client' and 'hydrus_server' as you like. The build is made on Ubuntu, so if you run something else, compatibility is hit and miss.
81
83
* If you have problems running the Ubuntu build, [running from source](running_from_source.md) is usually an improvement, and it is easy to set up these days.
Copy file name to clipboardExpand all lines: docs/getting_started_subscriptions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ If you discover your subscription workflow tends to be the same for each sub, yo
52
52
53
53
Some very advanced hydrus users do not publish anywere!
54
54
55
-
Note that subscription file import options will, by default, only present 'new' files. Anything already in the db will still be recorded in the internal import cache and used to calculate next check times and so on, but it won't clutter your import stream. This is different to the default for all the other importers, but when you are ready to enter the ranks of the Patricians, you will know to edit your 'loud' default file import options under _options->importing_ to behave this way as well. Efficient workflows only care about new files.
55
+
Note that subscription presentation import options will, by default, only present 'new' files. Anything already in the db will still be recorded in the internal import cache and used to calculate next check times and so on, but it won't clutter your import stream. This is different to the default for normal gallery pages, but when you are ready to enter the ranks of the Patricians, you might like to explore `options->import options` to see if this sort of behaviour might work for you elsewhere. Efficient workflows only care about new files.
56
56
57
57
## how exactly does the sync work? { id="syncing_explanation" }
0 commit comments