Skip to content

Commit

Permalink
Merge pull request #1427 from Zweibach/updating-docs
Browse files Browse the repository at this point in the history
Updating docs
  • Loading branch information
hydrusnetwork authored Aug 26, 2023
2 parents f16ba5f + 7d77973 commit 6793dbd
Show file tree
Hide file tree
Showing 27 changed files with 23 additions and 21 deletions.
7 changes: 2 additions & 5 deletions docs/advanced_parents.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ graph TB

Some franchises are bananas:

![](images/azur_hell.png)
![](images/poke_hell.png)

Also, unlike siblings, which as we previously saw are `n->1`, some tags have more than one implication (`n->n`):

Expand Down Expand Up @@ -89,7 +89,7 @@ Tags can have multiple parents, and multiple tags have the same parent. Loops ar

## how you do it { id="how_to_do_it" }

Go to _services->manage tag parents_:
Go to _tags->manage tag parents_:

![](images/tag_parents_dialog.png)

Expand All @@ -101,9 +101,6 @@ Once you have some relationships added, the parents and grandparents will show i

![](images/tag_parents_ac_1.png)

Hitting enter on cersei will try to add _house lannister_ and _series:game of thrones_ as well.

![](images/tag_parents_ac_2.png)

## remote parents { id="remote_parents" }

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced_siblings.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Note that if you say `A->B`, you cannot also say `A->C`. This is an `n->1` relat

## how you do it { id="how_to_do_it" }

Just open _services->manage tag siblings_, and add a few.
Just open _tags->manage tag siblings_, and add a few.

![](images/tag_siblings_dialog.png)

Expand Down
17 changes: 12 additions & 5 deletions docs/getting_started_downloading.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,26 @@ There are a number of different downloader types, each with its own purpose. Thi
**Simple downloader**
: Intended for simple one-off jobs like grabbing all linked images in a page.

# Import options
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.

## File import settings
File import settings has a number of options that deal with the files being downloaded and what should happen to them. There's a few more tickboxes if you turn on advanced mode
File import settings has a number of options that deal with the files being downloaded and what should happen to them. There's a few more tickboxes if you turn on advanced mode.

![](images/file_import.png)

**Pre-import checks**
: 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.
**pre-import checks**
: 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.
A few of the options have more information if you hover over them.

**Import destinations**
**import destinations**
: See [multiple file services](advanced_multiple_local_file_services.md), an advanced feature.

**post import actions**
: 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.

## Parsing
By default, hydrus now starts with a local tag service 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 `tag import options`:
By default, hydrus now starts with a local tag service 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`:

![](images/tag_import_options_default.png)

Expand Down
4 changes: 1 addition & 3 deletions docs/getting_started_more_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ You can watch more detailed synchronisation progress in the _services->review se

![](images/review_repos_public_tag_repo.png)

Your new service should now be listed on the left of the manage tags dialog. Adding tags to a repository works very similarly to the 'my tags' service except hitting 'apply' will not immediately confirm your changes--it will put them in a queue to be uploaded. These 'pending' tags will be counted with a plus '+' or minus '-' sign:

[![](images/rlm_pending.png)](images/rlm_pending.png)
Your new service should now be listed on the left of the manage tags dialog. Adding tags to a repository works very similarly to the 'my tags' service except hitting 'apply' will not immediately confirm your changes--it will put them in a queue to be uploaded. These 'pending' tags will be counted with a plus '+' or minus '-' sign.

Notice that a 'pending' menu has appeared on the main window. This lets you start the upload when you are ready and happy with everything that you have queued.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started_ratings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The hydrus client supports two kinds of ratings: _like/dislike_ and _numerical_.

## like/dislike { id="like_dislike" }

A new client starts with one of these, called 'favourites'. It can set one of two values to a file. It does not have to represent like or dislike--it can be anything you want, like 'send to export folder' or 'explicit/safe' or 'cool babes'. Go to _services->manage services->local->like/dislike ratings_:
A new client starts with one of these, called 'favourites'. It can set one of two values to a file. It does not have to represent like or dislike--it can be anything you want, like 'send to export folder' or 'explicit/safe' or 'cool babes'. Go to _services->manage services->add->local like/dislike ratings_:

![](images/ratings_like.png)

Expand Down
12 changes: 6 additions & 6 deletions docs/getting_started_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Your client starts with two [local tags services](getting_started_tags.md#tag_se

Select a file and press F3:

[![](images/sororitas_local.png)](images/sororitas_local.png)
[![](images/manage_tags.png)](images/manage_tags.png)

The area below where you type is the 'autocomplete dropdown'. You will see this on normal search pages too. Type part of a tag, and matching results will appear below. Since you are starting out, your 'my tags' service won't have many tags in it yet, but things will populate fast! Select the tag you want with the arrow keys and hit enter. If you want to remove a tag, enter the exact same thing again or double-click it in the box above.

Expand All @@ -30,14 +30,14 @@ The client is set up to draw common namespaces in different colours, just like b

Once you are happy with your tags, hit 'apply' or just press enter on the text box when it is empty.

[![](images/sororitas_local_done.png)](images/sororitas_local_done.png)

The tags are now saved to your database. On any search page, you can now type one in and be able to find everything with that tag::

[![](images/sororitas_search.png)](images/sororitas_search.png)
[![](images/search_hu_tao.png)](images/search_hu_tao.png)

If you add more 'search predicates' to a search, you will limit the results to those files that match every single one:

[![](images/sororitas_hanako.png)](images/sororitas_hanako.png)
[![](images/search_hu_tao_solo.png)](images/search_hu_tao_solo.png)

You can also exclude a tag by prefixing it with a hyphen (e.g. `-solo`).

You can also exclude a tag by prefixing it with a hyphen (e.g. `-heresy`).
[![](images/search_hu_tao_not_solo.png)](images/search_hu_tao_not_solo.png)
Binary file removed docs/images/azur_hell.png
Binary file not shown.
Binary file modified docs/images/downloader_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/dupe_merge_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/file_import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/hydrus_tag_archive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/import_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/manage_tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/poke_hell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ratings_like.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ratings_numerical.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ratings_system_pred.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/search_hu_tao.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/search_hu_tao_not_solo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/search_hu_tao_solo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tag_import_options_default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tag_import_options_specific.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tag_parents_ac_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/tag_parents_ac_2.png
Binary file not shown.
Binary file modified docs/images/tag_parents_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tag_siblings_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/watcher_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6793dbd

Please sign in to comment.