Skip to content

Commit

Permalink
Deployed 1a9162a with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jan 23, 2025
1 parent 5f35fc7 commit 696fb3a
Show file tree
Hide file tree
Showing 13 changed files with 197 additions and 118 deletions.
4 changes: 2 additions & 2 deletions beta/beta/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1142,7 +1142,7 @@


<h1 id="documentation-for-beta-releases">Documentation for Beta Releases<a class="headerlink" href="#documentation-for-beta-releases" title="Permanent link">&para;</a></h1>
<p>Here you can find documentation on changes and additions that are only present in the beta release.</p>
<p>Here you can find documentation on changes and additions that are only present in the beta release. Currently, there is no beta release.</p>



Expand All @@ -1163,7 +1163,7 @@ <h1 id="documentation-for-beta-releases">Documentation for Beta Releases<a class
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-09-05T20:37:23+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-05</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-01-23T14:15:51+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-01-23</span>
</span>


Expand Down
14 changes: 5 additions & 9 deletions general_info/downloading/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1142,15 +1142,11 @@


<h1 id="downloading">Downloading<a class="headerlink" href="#downloading" title="Permanent link">&para;</a></h1>
<p>When a GC release has been chosen, either by you or by Kapowarr, Kapowarr will try to find a download link (or multiple) on the page to use for downloading the file(s).<br />
How Kapowarr decides which link(s) to use, is broken down in the following steps.</p>
<p>When a GetComics (GC) release has been chosen, either by you or by Kapowarr, Kapowarr will try to find a download link (or multiple) on the page to use for downloading the file(s). How Kapowarr decides which link(s) to use, is broken down in the following steps:</p>
<ol>
<li>GetComics (GC) often offers multiple services for the same download. Kapowarr first analyses the page and collects all groups and their links (one group per download).</li>
<li>Next, it will combine multiple groups to cover as many issues as possible (if the download is for more than one issue).<br />
This collection of groups will form a 'path'. Groups are only added to a path if Kapowarr thinks that the group is actually downloading something we want.<br />
There can be multiple paths, in the case where there are conflicting groups. For example when there is a torrent download for all issues and multiple other downloads for issues 1-10, 11-20, etc.</li>
<li>All the links in the first path are tested, to see if they work, are supported and are allowed by the blocklist.<br />
A link could not be supported because the service is simply not supported, or because it's a torrent download and no torrent client is set up. If enough links pass, all the downloads in the path are added to the queue to be downloaded. If not enough links pass, the next path is tested until one is found that passes. If none pass, the page is added to the blocklist for having no working links.</li>
<li>GC often offers multiple services for the same download. Kapowarr first analyses the page and collects all groups and their links (one group per download).</li>
<li>Next, it will combine multiple groups to cover as many issues as possible (if the download is for more than one issue). This collection of groups will form a 'path'. Groups are only added to a path if Kapowarr thinks that the group is actually downloading something we want. There can be multiple paths, in the case where there are conflicting groups. For example when there is a torrent download for all issues and multiple other downloads for issues 1-10, 11-20, etc.</li>
<li>All the links in the first path are tested, to see if they work, are supported and are allowed by the blocklist. A link could not be supported because the service is simply not supported, or because it's a torrent download and no torrent client is set up. If enough links pass, all the downloads in the path are added to the queue to be downloaded. If not enough links pass, the next path is tested until one is found that passes. If none pass, the page is added to the blocklist for having no working links.</li>
<li>When a path passes and it's groups are added to the download queue, a decision needs to be made for which service is going to be used for each group (direct download, Mega, MediaFire, etc.). The <a href="../../settings/download/#service-preference">'Service Preference' setting</a> decides this.</li>
</ol>
<p>If Kapowarr downloads less (or nothing at all) from a page, but you are convinced that that shouldn't be the case, read about this topic <a href="../../other_docs/faq/#why-does-kapowarr-not-grab-the-links-from-a-gc-page-even-though-they-work-fine">on the FAQ page</a>.</p>
Expand All @@ -1174,7 +1170,7 @@ <h1 id="downloading">Downloading<a class="headerlink" href="#downloading" title=
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-09-05T20:37:23+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-05</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-01-23T14:15:51+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-01-23</span>
</span>


Expand Down
10 changes: 5 additions & 5 deletions general_info/features/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1267,18 +1267,18 @@ <h1 id="features">Features<a class="headerlink" href="#features" title="Permanen
<h2 id="library-import">Library Import<a class="headerlink" href="#library-import" title="Permanent link">&para;</a></h2>
<p>The feature 'Library Import' makes it possible to import an existing library into Kapowarr. You could have an existing library because you used a different software before, or because you downloaded media manually. In that case, Library Import makes it easy to start using Kapowarr.</p>
<h3 id="proposal">Proposal<a class="headerlink" href="#proposal" title="Permanent link">&para;</a></h3>
<p>When you run Library Import, it will search for files in your root folders that aren't matched to any issues yet. It will then try to find the volume for the file on CV. This list of files and CV matches gets presented to you (a.k.a. Library Import proposal). You can then change the matches, in case Kapowarr guessed incorrectly. You can choose to apply the changed match to only the file, or to all files for the volume.</p>
<p>When you run Library Import, it will search for files in your root folders that aren't matched to any issues yet. It will then try to find the volume for the file on ComicVine. This list of files and ComicVine matches is presented to you (a.k.a. Library Import proposal). You can then change the matches in case Kapowarr guessed incorrectly. You can choose to apply the changed match to only the file, or to all files for the volume.</p>
<p>On the start screen, there are some settings that change the behaviour of Library Import:</p>
<ul>
<li><strong>Max folders scanned</strong>: Limit the proposal to this amount of folders (roughly equal to the amount of volumes). Setting this to a large amount increases the chance of hitting the <a href="../../other_docs/rate_limiting/">CV rate limit</a>.</li>
<li><strong>Apply limit to parent folder</strong>: Apply the folder limit (prev. bullet) to the parent folder instead of the folder. Enable this when each issue has it's own sub-folder.</li>
<li><strong>Only match english volumes</strong>: When Kapowarr is searching on CV for a match for a file, only allow the match when it's an english release. So it won't allow translations.</li>
<li><strong>Apply limit to parent folder</strong>: Apply the folder limit (see previous bullet) to the parent folder instead of the folder. Enable this when each issue has it's own sub-folder.</li>
<li><strong>Only match english volumes</strong>: When Kapowarr is searching on ComicVine for a match to the file, only allow the match when it's an english release; it won't allow translations.</li>
<li><strong>Folder(s) to scan</strong>: Allows you to supply a specific folder to scan, instead of all root folders. Supports glob patterns (e.g. <code class="highlight">/comics-1/Star Wars*</code>).</li>
</ul>
<h3 id="importing">Importing<a class="headerlink" href="#importing" title="Permanent link">&para;</a></h3>
<p>When you are happy with the proposal, you have two options: 'Import' and 'Import and Rename'. Clicking 'Import' will make Kapowarr add all the volumes and set their volume folder to the folder that the file is in. Clicking 'Import and Rename' will make Kapowarr add all the volumes and move the files into the automatically generated volume folder, after which it will rename them.</p>
<h3 id="implementation-details">Implementation Details<a class="headerlink" href="#implementation-details" title="Permanent link">&para;</a></h3>
<p>When 'Import' is used, the volume folder that is set is the 'lowest common folder'. This is the lowest folder that still contains all files that are matched to that volume.</p>
<p>When 'Import' is used, the volume folder that is set is the 'deepest common folder'. This is the deepest folder that still contains all files that are matched to that volume.</p>
<p>If the CV rate limit is reached halfway through the proposal, the unhandled files will have no match. Files that don't have a match linked to them will be ignored when importing, regardless of the state of the checkbox for that file. It's advised to wait a few minutes and then do another run.</p>
<p>If you imported files but certain ones pop up again in the next run, see the <a href="../../other_docs/faq/#why-do-certain-files-pop-up-in-the-library-import-even-though-i-just-imported-them">FAQ on this topic</a>.</p>

Expand All @@ -1301,7 +1301,7 @@ <h3 id="implementation-details">Implementation Details<a class="headerlink" href
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-09-05T20:37:23+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-09-05</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-01-23T14:15:51+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-01-23</span>
</span>


Expand Down
Loading

0 comments on commit 696fb3a

Please sign in to comment.