Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify admin UI button behavior + document the details of how they behave #930

Open
meonkeys opened this issue Feb 16, 2022 · 7 comments
Open
Labels
expected: maybe someday help wanted size: easy status: idea-phase Work is tentatively approved and is being planned / laid out, but is not ready to be implemented yet touches: docs touches: js Pull requests that update Javascript code type: enhancement why: functionality Intended to improve ArchiveBox functionality or features
Milestone

Comments

@meonkeys
Copy link

meonkeys commented Feb 16, 2022

Hi there! Just had a few questions.

  1. What does "title" do in the web UI? It appears to re-try fetching headers, favicon, and HTML title for content at a URL -- is that correct?
  2. What does "pull" do in the web UI?
  3. How about if we added tooltips (HTML title attributes) to the "title", "pull", "re-snapshot", "reset", and "delete" buttons to /admin/core/snapshot/ in the web UI? I couldn't find an existing issue for this. I'm happy to file one and help out.
  4. Say I used re-snapshot a bunch of days in a row. Is there some easy way to see/list all the versions I've snapshotted for a particular URL? When I click "History" on the admin page for a snapshot, it says "This object doesn’t have a change history. It probably wasn’t added via this admin site.". I saw Add official support for taking multiple snapshots of websites over time #179 so I'm guessing this isn't implemented yet.
  5. Sometimes when I visit the index page for a snapshot, my browser (Firefox) starts automatically downloading an output.pdf file. Why? example archivebox snapshot index page showing this behavior
  6. Is there any way to strip ads and trackers? found Architecture: Block ads and trackers during archiving #211 , awesome!

Thank you, -Adam

@akhilleusuggo
Copy link
Contributor

How about if we added tooltips (HTML title attributes) to the "title", "pull", "re-snapshot", "reset", and "delete" buttons to /admin/core/snapshot/ in the web UI? I couldn't find an existing issue for this. I'm happy to file one and help out.

-Title : Pull the title ( redownload if it was missing, or the title has changed )

-Pull: Download missing/failed outputs/extractors methods ( pdf, wget... etc). Maybe because download failed or interrupted by a reboot or something. This is the default behavior when you add new URL, they will get pulled automatically. https://github.com/ArchiveBox/ArchiveBox#output-formats

-Re-snapshot: As the name suggests, re-download the page as a separated unique page. Not the same as pull, this one will create a separate entry, and the page is treated as a new URL ending with the date and time #2020-10-24-08:00 https://github.com/ArchiveBox/ArchiveBox#saving-multiple-snapshots-of-a-single-url

-Reset: Delete all type of output and redownload them. In the contrary of snapshot, this will overwrite the files.

@meonkeys
Copy link
Author

I added your documentation to https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#explanation-of-buttons-in-the-web-ui---admin-snapshots-list ! I hope this is OK.

@meonkeys
Copy link
Author

Any thoughts on 5 above (output.pdf)?

@akhilleusuggo
Copy link
Contributor

Maybe you browser doesn't support PDF and needs to download it since it can't open it. ( I don't think is the reason but it could be )

But I don't understand what do you mean by

Sometimes when I visit the index page for a snapshot

If you browser does support PDF reading then should not be any problem. Tweak this settings. Must be set to open in firefox

image

@meonkeys
Copy link
Author

Oh dangit, you're right!

For posterity: it looks like Firefox must indeed be configured to open PDFs in Firefox (as opposed to the other options: Always ask, Save File, etc) for this to work properly. On a snapshot index page, the PDF viewer tries to open the PDF in an iframe. If Firefox is set to Save File, the iframe instead ends up triggering a file download of output.pdf.

@pirate
Copy link
Member

pirate commented Mar 9, 2023

Considering re-naming these buttons for clarity + updating the tooltip help text that appears on hover:

  • ⬇️ Title -> Get title (Make an initial request to fetch the page's title, headers, and response code)
  • Pull -> Resume (Resume archiving a snapshot that was interrupted during archiving / retry any methods that failed to produce output on the first try)
  • Re-Snapshot -> Re-Snapshot URL (Create a new separate snapshot of this URL and archive it from scratch as it appears right now)
  • Reset -> - just going to remove this button I think, I don't think it's that useful and you can accomplish it with Re-Snapshot + Delete on the original
  • Delete -> stays the same

Open to suggestions. The difficulty is that I have to keep these really short to fit them in the UI nicely (especially for smaller screen sizes), otherwise it would be easy to give them long descriptive names.

@pirate pirate reopened this Mar 9, 2023
@pirate pirate changed the title Question: what do title, pull, re-snapshot do exactly? Clarify admin UI button behavior + document the details of how they behave Mar 9, 2023
@pirate pirate added status: idea-phase Work is tentatively approved and is being planned / laid out, but is not ready to be implemented yet why: functionality Intended to improve ArchiveBox functionality or features size: easy help wanted touches: docs type: enhancement touches: js Pull requests that update Javascript code expected: maybe someday labels Mar 9, 2023
@meonkeys
Copy link
Author

What if you we left ⬇️ Title as-is, but added a long tooltip? We could use long, descriptive text in the tooltip: exactly what you wrote in parens. So ⬇️ Title stays the same, but when you hover over it you see Make an initial request to fetch the page's title, headers, and response code.

Renaming Pull to Resume sounds great, as does getting rid of Reset.

Resume tooltip: Resume archiving a snapshot that was interrupted during archiving / retry any methods that failed to produce output on the first try.

Re-Snapshot seems fine as-is, especially if it gets the tooltip Create a new separate snapshot of this URL and archive it from scratch as it appears right now.

Delete seems clear as-is, without a tooltip.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
expected: maybe someday help wanted size: easy status: idea-phase Work is tentatively approved and is being planned / laid out, but is not ready to be implemented yet touches: docs touches: js Pull requests that update Javascript code type: enhancement why: functionality Intended to improve ArchiveBox functionality or features
Projects
None yet
Development

No branches or pull requests

3 participants