tim/bindery
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

Name the publishing site in the README

Browse Source 
"The site" could mean the publishing site of a story or the Bindery
site. Name the publishing site, its publisher and its published text.
This commit is contained in:
tim
2026-10-03 11:23:28 +02:00
parent 5ac56de09d
commit 60424e8e74
1 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -21
View File
@@ -12,8 +12,8 @@ FanFicFare builds a book from the chapter list on the site, so a chapter that th
also goes from your book. **Bindery keeps every chapter that it downloads** in its own database, and also goes from your book. **Bindery keeps every chapter that it downloads** in its own database, and
builds each ePub from that database. builds each ePub from that database.
- **Chapters that the site removes stay in the book.** A new chapter goes after the chapter that - **Chapters that the publisher removes stay in the book.** A new chapter goes after the chapter that
comes before it on the site. For example, you have chapters 1 to 60, and the site now lists only 1 comes before it on the publishing site. For example, you have chapters 1 to 60, and the publishing site now lists only 1
to 4 and 61. The book then has chapters 1 to 61. to 4 and 61. The book then has chapters 1 to 61.
- **A changed chapter keeps its old text as a revision.** You can compare the revisions and choose - **A changed chapter keeps its old text as a revision.** You can compare the revisions and choose
the one that goes in the book. the one that goes in the book.
@@ -245,7 +245,7 @@ In the `cwa` and `proxy` modes, `BINDERY_ADMIN_USERS` lists the users that are a
- Open the Settings page, and change the settings on it. - Open the Settings page, and change the settings on it.
- Change the global replacement rules. - Change the global replacement rules.
- Read and change `personal.ini`, which can hold passwords for story sites. - Read and change `personal.ini`, which can hold passwords for publishing sites.
Each other user can still add, update and delete stories, and change the settings and the rules of a Each other user can still add, update and delete stories, and change the settings and the rules of a
story. Bindery ignores the case of the names. story. Bindery ignores the case of the names.
@@ -322,7 +322,7 @@ The catalog has three lists, with 50 books per page:
- By Last Changed, with the newest change first. - By Last Changed, with the newest change first.
A book appears when it has a stored, included chapter. It shows its authors, series, description, tags, A book appears when it has a stored, included chapter. It shows its authors, series, description, tags,
language and cover, with your kept values in place of the site values. A reader can search by title, language and cover, with your kept values in place of the published values. A reader can search by title,
author, series and tag. A download uses the stored chapters, the current ePub rules and the download author, series and tag. A download uses the stored chapters, the current ePub rules and the download
template for the file name. template for the file name.
@@ -352,13 +352,13 @@ explains the format, and
setting. Bindery reads the file for each job, so a change applies to the next job. setting. Bindery reads the file for each job, so a change applies to the next job.
You can edit the file on the Settings page. Bindery refuses a file that FanFicFare cannot read, and You can edit the file on the Settings page. Bindery refuses a file that FanFicFare cannot read, and
shows FanFicFare's warnings for other problems. **The file can hold passwords for story sites, and shows FanFicFare's warnings for other problems. **The file can hold passwords for publishing sites, and
each admin can read them.** If `BINDERY_ADMIN_USERS` is not set, each user is an admin. See "Admins". each admin can read them.** If `BINDERY_ADMIN_USERS` is not set, each user is an admin. See "Admins".
Bindery always sets `always_reload_first_chapter`, `mark_new_chapters`, `continue_on_chapter_error`, Bindery always sets `always_reload_first_chapter`, `mark_new_chapters`, `continue_on_chapter_error`,
`make_directories`, `zip_output` and `calibre_series_meta`, because it needs fixed values for them. `make_directories`, `zip_output` and `calibre_series_meta`, because it needs fixed values for them.
**Each book gets the cover from the site.** FanFicFare downloads the cover only if `include_images` **Each book gets the cover from the publisher.** FanFicFare downloads the cover only if `include_images`
is on. If it is off, Bindery sets it to `coveronly`, which keeps the cover but leaves out the images is on. If it is off, Bindery sets it to `coveronly`, which keeps the cover but leaves out the images
in the story text. in the story text.
@@ -461,7 +461,7 @@ Make a CWA user for Bindery with these settings:
- The download permission. Bindery reads story URLs and chapters from the ePubs. - The download permission. Bindery reads story URLs and chapters from the ePubs.
- "Show Publisher Section", in the sidebar settings of the user. CWA shows its list of publishers in - "Show Publisher Section", in the sidebar settings of the user. CWA shows its list of publishers in
OPDS only to users with this setting. "Import from the library" uses the list to find the books of OPDS only to users with this setting. "Import from the library" uses the list to find the books of
story sites, because FanFicFare sets the publisher of a book to the site name. publishing sites, because FanFicFare sets the publisher of a book to the site name.
- Access to all books. Bindery finds only the books that this account can see. - Access to all books. Bindery finds only the books that this account can see.
Bindery sends the password of this account with each OPDS request. **Use a password that no other Bindery sends the password of this account with each OPDS request. **Use a password that no other
@@ -472,7 +472,7 @@ unset, and give the guest user of CWA the settings above.
## Import an ePub file ## Import an ePub file
If the site removed chapters before Bindery tracked the story, import an ePub that you made earlier If the publishing site removed chapters before Bindery tracked the story, import an ePub that you made earlier
with FanFicFare. Bindery stores its chapters as if it downloaded them. Chapters that the site with FanFicFare. Bindery stores its chapters as if it downloaded them. Chapters that the site
publishes later go after them. publishes later go after them.
@@ -485,7 +485,7 @@ publishes later go after them.
that FanFicFare writes into each ePub. A chapter that Bindery stored already keeps its stored text. that FanFicFare writes into each ePub. A chapter that Bindery stored already keeps its stored text.
The other chapters go in the order of the ePub. The other chapters go in the order of the ePub.
After the import, Bindery checks the site for new chapters and sends the book to CWA. If you clear After the import, Bindery checks the publishing site for new chapters and sends the book to CWA. If you clear
"Check the site for new chapters after import", Bindery only rebuilds the book of a story that it "Check the site for new chapters after import", Bindery only rebuilds the book of a story that it
downloaded before. downloaded before.
@@ -518,7 +518,7 @@ Bindery field. Calibre does not have it, and gives empty text for it.
| `{series_index}` | The series number: `2`, or `2.5`. | | `{series_index}` | The series number: `2`, or `2.5`. |
| `{tags}` | The tags in sorted order, with `, ` between them. | | `{tags}` | The tags in sorted order, with `, ` between them. |
| `{languages}` | The language, as Bindery stores it. | | `{languages}` | The language, as Bindery stores it. |
| `{publisher}` | The story site. | | `{publisher}` | The publishing site. |
| `{pubdate}` | The published date. | | `{pubdate}` | The published date. |
| `{timestamp}` | The date when Bindery added the story. | | `{timestamp}` | The date when Bindery added the story. |
| `{last_modified}` | The date when the chapters last changed. | | `{last_modified}` | The date when the chapters last changed. |
@@ -555,8 +555,8 @@ does not change the names of the files in `INGEST_DIR`. The browser can ignore t
| --- | --- | | --- | --- |
| Download new chapters | Downloads the chapters that are not stored yet. The default, and what scheduled updates use. | | Download new chapters | Downloads the chapters that are not stored yet. The default, and what scheduled updates use. |
| Recheck selected chapters | Downloads the selected chapters again. Changed text becomes a new revision. | | Recheck selected chapters | Downloads the selected chapters again. Changed text becomes a new revision. |
| Recheck all chapters | Downloads every chapter on the site again, and new chapters too. | | Recheck all chapters | Downloads every chapter on the publishing site again, and new chapters too. |
| Download and replace entire book | Downloads every chapter again. Chapters that the site no longer lists leave the book. They stay stored, and you can put them back. | | Download and replace entire book | Downloads every chapter again. Chapters that the publishing site no longer lists leave the book. They stay stored, and you can put them back. |
| Update metadata from site | Updates only the metadata in the ePub. | | Update metadata from site | Updates only the metadata in the ePub. |
| Rebuild book | Builds the book again from the stored chapters, and sends it. | | Rebuild book | Builds the book again from the stored chapters, and sends it. |
@@ -576,26 +576,26 @@ recheck, or use one of these settings:
story. This recheck takes the place of the next scheduled update. The story then ignores the "last story. This recheck takes the place of the next scheduled update. The story then ignores the "last
N chapters" setting. N chapters" setting.
Each rechecked chapter is one request to the site, so keep the numbers small for long stories. Each rechecked chapter is one request to the publishing site, so keep the numbers small for long stories.
If the site changes the title of a chapter, "Download new chapters" and "Recheck selected chapters" If the publishing site changes the title of a chapter, "Download new chapters" and "Recheck selected chapters"
download that chapter again. The chapter gets the new title only if the download works. On sites download that chapter again. The chapter gets the new title only if the download works. On sites
that number chapter URLs, such as FanFiction.net, this also finds chapters that moved when the that number chapter URLs, such as FanFiction.net, this also finds chapters that moved when the
author inserted a chapter. author inserted a chapter.
### Revisions ### Revisions
A recheck compares the text of a chapter with its newest revision, which is the text that the site A recheck compares the text of a chapter with its newest revision, which is the text that the publishing site
sent last. Bindery stores the HTML as the site sends it, before the rules, so a rule never makes a sent last. Bindery stores the HTML as the publishing site sends it, before the rules, so a rule never makes a
chapter look changed. chapter look changed.
- If the text changed, the new revision goes in the book. If you chose an older revision, it - If the text changed, the new revision goes in the book. If you chose an older revision, it
stays in the book until the site changes the chapter again. stays in the book until the publishing site changes the chapter again.
- On the page of a chapter, you can compare revisions, choose the one that goes in the book, and - On the page of a chapter, you can compare revisions, choose the one that goes in the book, and
delete the others. The revision in the book and the newest revision cannot be deleted. delete the others. The revision in the book and the newest revision cannot be deleted.
- A chapter imported from an ePub holds its text after the FanFicFare settings and rules of that - A chapter imported from an ePub holds its text after the FanFicFare settings and rules of that
build. If the current rules turn the site text into the imported text, Bindery counts the chapter build. If the current rules turn the published text into the imported text, Bindery counts the chapter
as unchanged, and stores the site text in its place. Other differences, for example from settings as unchanged, and stores the published text in its place. Other differences, for example from settings
in `personal.ini`, show as a change. in `personal.ini`, show as a change.
### Restarts ### Restarts
@@ -611,7 +611,7 @@ Bindery to start the thread again.
### Backups ### Backups
Once a day, Bindery copies its database and `personal.ini` to `/config/backups`, and keeps the Once a day, Bindery copies its database and `personal.ini` to `/config/backups`, and keeps the
copies of the last 7 days. **The database is the only copy of the chapters that sites removed.** The copies of the last 7 days. **The database is the only copy of the chapters that publishing sites removed.** The
backups are on the same disk, so also copy `/config` to another disk or machine. backups are on the same disk, so also copy `/config` to another disk or machine.
To restore a backup, do these steps: To restore a backup, do these steps:
@@ -628,7 +628,7 @@ Bindery keeps the metadata of each story in its database, and writes it into eac
are title, authors, description, tags, series, published date and language. Each field is locked or are title, authors, description, tags, series, published date and language. Each field is locked or
unlocked for each story: unlocked for each story:
- An unlocked field takes the site value on every update. - An unlocked field takes the published value on every update.
- A locked field keeps its stored value. The first download sets that value. For a story that you - A locked field keeps its stored value. The first download sets that value. For a story that you
import from the library or from an ePub file, the value comes from that ePub. import from the library or from an ePub file, the value comes from that ePub.
- To update a locked field once, select it under "Also take these locked or edited fields from the - To update a locked field once, select it under "Also take these locked or edited fields from the