Merge pull request #1151 from Zweibach/files

Thank you!

docs/gettingStartedOverview.md

@@ -5,11 +5,14 @@ title: Overview for getting started
 # Overview for getting started
 This page serves as a checklist or overview for the getting started part of Hydrus. It is recommended to read at least all of the getting started pages, but if you want to head to some specific section directly go ahead and do so.
 
+## The client
+Have a look at [getting started with files](getting_started_files.md) to get an overview of the Hydrus client.
+
 ## Local files
-If you already have many local files, either downloaded by hand or by some other downloader tool, head to the [getting started with files](getting_started_files.md) section to begin importing them.
+If you already have many local files, either downloaded by hand or by some other downloader tool, head to the [getting started importing](getting_started_importing.md) section to begin importing them.
 
 ## Downloading
-If you want to download with Hydrus, check out [getting started with downloading](getting_started_downloading.md) and then [getting started with subscriptions](getting_started_subscriptions.md). If you want to add the ability to download from sites not already available in Hydrus by default, check out [adding new downloaders](adding_new_downloaders.md) for how and a link to a user-maintained archive of downloaders.
+If you want to download with Hydrus, check out [getting started with downloading](getting_started_downloading.md). If you want to add the ability to download from sites not already available in Hydrus by default, check out [adding new downloaders](adding_new_downloaders.md) for how and a link to a user-maintained archive of downloaders.
 
 ## Tags and ratings
 If you have imported and/or downloaded some files and want to get started searching and tagging see [searching and sorting](getting_started_searching.md) and [getting started with ratings](getting_started_ratings.md).
@@ -22,4 +25,4 @@ It is also worth having a look at [siblings](advanced_siblings.md) for when you
 Have a lot of very similar looking pictures because of one reason or another? Have a look at [duplicates](duplicates.md), Hydrus' duplicates finder and filtering tool.
 
 ## API
-Hydrus has an API that lets external tools connect to it. See [API](client_api.md) for how to turn it on and a list of some of these tools.
+Hydrus has an API that lets external tools connect to it. See [API](client_api.md) for how to turn it on and a list of some of these tools.

docs/getting_started_exporting.md

@@ -1,49 +0,0 @@
----
-title: exporting files
----
-
-# exporting files
-
-## exporting { id="exporting" }
-
-There are many ways to export files from the client:
-
-* **drag and drop**
-    
-    Just dragging from the thumbnail view will export (copy) all the selected files to wherever you drop them. You can also start a drag and drop for single files from the media viewer using this arrow button on the top hover window:
-    
-    ![](images/media_viewer_dnd.png)
-    
-    If you want to drag and drop to discord, check the special BUGFIX option under _options->gui_.
-    
-    By default, the files will be named by their ugly hexadecimal [hash](faq.md#hashes), which is how they are stored inside the database. Once you learn filename patterns (practise with manual exports, as below!), you will be able to change this in the options if you wish.
-    
-    If you use a drag and drop to open a file inside an image editing program, remember to hit 'save as' and give it a new filename in a new location! The client does not expect files inside its db directory to ever change.
-    
-* **share->copy->files**
-    
-    This will copy the files themselves to your clipboard. You can then paste them wherever you like, just as with normal files. They will have their hashes for filenames.
-    
-    This is a very quick operation. It can also be triggered by hitting Ctrl+C.
-    
-* **share->copy->image (bitmap)**
-    
-    This copies a file's rendered image data to your clipboard. This is useful for pasting into an image editor, but do not use it to upload images to the internet. 
-    
-* **share->copy->hashes**
-    
-    This will copy the files' unique identifiers to your clipboard, in hexadecimal.
-    
-    You will not have to do this often. It is best when you want to identify a number of files to someone else without having to send them the actual files.
-    
-* **export dialog**
-    
-    Right clicking some files and selecting _share->export->files_ will open this dialog:
-    
-    ![](images/export.png)
-    
-    Which lets you export the selected files with custom filenames. It will initialise trying to export the files named by their hashes, but once you are comfortable with tags, you'll be able to generate much cleverer and prettier filenames.
-    
-* **export folders**
-    
-    You can set up a regularly repeating export under _file->import and export folders_. This is an advanced operation, so best left until you know the client a bit better, but it is very useful if you want to regularly export some of your collection to a revolving wallpaper directory or similar.

docs/getting_started_files.md

@@ -1,10 +1,8 @@
 ---
-title: files
+title: Files
 ---
 
-# getting started with files
-
-If any of this is confusing, a simpler guide is [here](https://github.com/Zweibach/text/blob/master/Hydrus/Hydrus%20Help%20Docs/00_tableOfContents.md), and some video guides are [here](https://github.com/CuddleBear92/Hydrus-guides)!
+# Getting started with files
 
 !!! warning
 
@@ -12,7 +10,7 @@ If any of this is confusing, a simpler guide is [here](https://github.com/Zweiba
 
 	There are no limits and few brakes on your behaviour. It is possible to import millions of files. For many new users, their first mistake is downloading too much too fast in overexcitement and becoming overwhelmed. Take things slow and figure out good processing workflows that work for your schedule before you start adding 500 subscriptions.
 
-## the problem { id="hellmode_dot_exe" }
+## The problem
 
 If you have ever seen something like this--
 
@@ -22,9 +20,9 @@ If you have ever seen something like this--
 
 Finding the right picture quickly can be difficult. Finding everything by a particular artist at a particular resolution is unthinkable. Integrating new files into the whole nested-folder mess is a further pain, and most operating systems bug out when displaying 10,000+ thumbnails.
 
-## so, what does the hydrus client do? { id="the_client" }
+## The client
 
-Let's first focus on _importing_ files.
+Let's first focus on [_importing_ files](getting_started_importing.md).
 
 When you first boot the client, you will see a blank page. There are no files in the database and so there is nothing to search. To get started, I suggest you simply drag-and-drop a folder with a hundred or so images onto the main window. A dialog will appear affirming what you want to import. Ok that, and a new page will open. Thumbnails will stream in as the software processes each file.
 
@@ -67,7 +65,7 @@ Now:
 *   Play with the system tags more if you like, and the sort-by dropdown. The collect-by dropdown is advanced, so wait until you understand _namespaces_ before expecting it to do anything.
 *   To close a page, middle-click its tab.
 
-The client can currently import the following mimetypes:
+### The client can currently import the following mimetypes:
 
 *   **image/bmp** (.bmp - converted to image/png on import)
 *   **image/gif** (.gif)
@@ -100,7 +98,7 @@ Although some support is imperfect for the complicated filetypes. For the Window
 
 The client can also download files from several websites, including 4chan and other imageboards, many boorus, and gallery sites like deviant art and hentai foundry. You will learn more about this later.
 
-## inbox and archiving { id="inbox" }
+## Inbox and archive
 
 The client sends newly imported files to an **inbox**, just like your email. Inbox acts like a tag, matched by 'system:inbox'. A small envelope icon is drawn in the top corner of all inbox files:
 
@@ -116,11 +114,11 @@ A trashed file will not appear in subsequent normal searches, although you can s
 
 A quick way of processing new files is–
 
-## filtering { id="filtering_inbox" }
+### Filtering your inbox
 
 Lets say you just downloaded a good thread, or perhaps you just imported an old folder of miscellany. You now have a whole bunch of files in your inbox--some good, some awful. You probably want to quickly go through them, saying _yes, yes, yes, no, yes, no, no, yes_, where _yes_ means 'keep and archive' and _no_ means 'delete this trash'. **Filtering** is the solution.
 
-Select some thumbnails, and either choose _filter->archive/delete_ from the right-click menu or hit F12. You will see them in a special version of the media viewer, with the following controls:
+Select some thumbnails, and either choose _filter->archive/delete_ from the right-click menu or hit F12. You will see them in a special version of the media viewer, with the following default controls:
 
 *   ++left-button++, ++space++, or ++f7++: **keep and archive the file, move on**
 *   ++right-button++ or ++delete++: **delete the file, move on**
@@ -132,11 +130,11 @@ Your choices will not be committed until you finish filtering.
 
 This saves time.
 
-## lastly { id="what_hydrus_is_for" }
+## What Hydrus is for
 
 The hydrus client's workflows are not designed for half-finished files that you are still working on. Think of it as a giant archive for everything excellent you have decided to store away. It lets you find and remember these things quickly.
 
-In general, hydrus is good for individual files like you commonly find on imageboards or boorus. Although advanced users can cobble together some page-tag-based solutions, it is not yet great for multi-file media like comics and definitely not as a typical playlist-based music player.
+In general, Hydrus is good for individual files like you commonly find on imageboards or boorus. Although advanced users can cobble together some page-tag-based solutions, it is not yet great for multi-file media like comics and definitely not as a typical playlist-based music player.
 
 If you are looking for a comic manager to supplement hydrus, check out this user-made guide to other archiving software [here](https://github.com/CuddleBear92/Hydrus-Presets-and-Scripts/wiki/0-Alternative-Programs-and-Resources#software)!
 

docs/getting_started_importing.md

@@ -0,0 +1,71 @@
+---
+title: Importing and exporting
+---
+
+# Importing and exporting
+
+By now you should have launched Hydrus. If you're like most new users you probably already have a fair bit of images or other media files that you're looking at getting organised.
+
+!!! note
+    If you're planning to import or export a large amount of files it's recommended to use the [automated folders](#automation) since Hydrus can have trouble dealing with large, single jobs. Splitting them up in this manner will make it much easier on the program.
+
+## Importing files
+Navigate to `file -> import files` in the toolbar.  
+**OR**  
+Drag-and-drop one or more folders or files into Hydrus.
+
+![](images/review_files_to_import.png)
+
+This will open the `import files` window. Here you can add files or folders, or delete files from the import queue. Let Hydrus parse what it will update and then look over the options. By default the option to delete original files after succesful import (if it's ignored for any reason or already present in Hydrus for example) is not checked, activate on your own risk. In `file import options` you can find some settings for minimum and maximum file size, resolution, and whether to import previously deleted files or not.
+
+From here there's two options: `import now` which will just import as is, and `add tags before import >>` which lets you set up some rules to add tags to files on import.  
+Examples are keeping filename as a tag, add folders as tag (useful if you have some sort of folder based organisation scheme), or load tags from an accompanying .txt file generated by some other program.
+
+Once you're done click apply (or `import now`) and Hydrus will start processing the files. Exact duplicates are not imported so if you had dupes spread out you will end up with only one file in the end. If files *look* similar but Hydrus imports both then that's a job for the [dupe filter](duplicates.md) as there is some difference even if you can't tell it by eye. A common one is compression giving files with different file sizes, but otherwise looking identical or files with extra meta data baked into them.
+
+## Exporting files
+If you want to share your files then export is the way to go. Basic way is to mark the files in Hydrus, dragging from there and dropping the files where you want them. You can also copy files or use export files to, well, export your files to a select location. All (or at least most) non-drag'n'drop export options can be found on right-clicking the select files and going down `share` and then either `copy` or `export`.
+
+### Drag'n'drop
+Just dragging from the thumbnail view will export (copy) all the selected files to wherever you drop them. You can also start a drag and drop for single files from the media viewer using this arrow button on the top hover window:
+    
+![](images/media_viewer_dnd.png)
+    
+If you want to drag and drop to discord, check the special BUGFIX option under `options > gui`. You also find a filename pattern setting for that drag and drop here.
+    
+By default, the files will be named by their ugly hexadecimal [hash](faq.md#hashes), which is how they are stored inside the database.
+    
+If you use a drag and drop to open a file inside an image editing program, remember to hit 'save as' and give it a new filename in a new location! The client does not expect files inside its db directory to ever change.
+
+### Copy
+You can also copy the files by right-clicking and going down `share -> copy -> files` and then pasting the files where you want them.
+
+### Export
+You can also export files with tags, either in filename or as a side-car .txt file by right-clicking and going down `share -> export -> files`. Have a look at the settings and then press `export`.  
+You can create folders to export files into by using backslashes on Windows (`\`) and slashes on Linux (`/`) in the filename. This can be combined with the patterns listed in the pattern shortcut button dropdown. As example `[series]\{filehash}` will export files into folders named after the `series:` namespaced tags on the files, all files tagged with one series goes into one folder, files tagged with another series goes into another folder as seen in the image below.
+
+![](images/export_files.png)
+
+Clicking the `pattern shortcuts` button gives you an overview of available patterns.
+
+The EXPERIMENTAL option is only available under advanced mode, use at your own risk.
+
+## Automation
+Under `file -> import and export folders` you'll find options for setting up automated import and export folders that can run on a schedule. Both have a fair deal of options and rules you can set so look them over carefully.
+
+### Import folders
+![](images/import_folder.png)
+
+To import tags you have to add a tag service under the `filename tagging` section.
+
+### Export folders
+![](images/export_folder.png)
+
+You can currently not export tags in a .txt file with export folder liks you can when doing normal exports unfortunately.
+
+## Importing and exporting tags
+While you can import and export tags together with images sometimes you just don't want to deal with the files.
+
+Going to `tags -> migrate tags` you get a window that lets you deal with just tags. One of the options here is what's called a Hydrus Tag Archive, a file containing the hash <-> tag mappings for the files and tags matching the query.
+
+![](images/hydrus_tag_archive.png)

mkdocs.yml

@@ -11,6 +11,7 @@ nav:
     - gettingStartedOverview.md
     - getting_started_installing.md
     - getting_started_files.md
+    - getting_started_importing.md
     - getting_started_searching.md
     - getting_started_tags.md
     - getting_started_downloading.md
@@ -20,7 +21,6 @@ nav:
       - PTR.md
       - petitionPractices.md
     - Next Steps:
-      - getting_started_exporting.md
       - adding_new_downloaders.md
       - getting_started_subscriptions.md
       - filtering duplicates: duplicates.md