EbookFoundation
/
gutenbergsite
mirror of https://github.com/EbookFoundation/gutenbergsite.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Small updates.

bookshelf
Gutenberg back end service account 2020-01-24 23:36:30 -05:00
parent dff708de30
commit 4e03999822
3 changed files with 56 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
_includes/menu.html
View File

@ -10,32 +10,17 @@
<ul id="menu">
<li><a href="/about/">About</a>
<ul class="hidden">
<li><a href="/about/">About Project Gutenberg &rarr;</a></li>
<li><a href="/about/">About Project Gutenberg</a></li>
<li><a href="/policy/collection_development.html">Collection Development</a></li>
<li><a href="/about/contact_information.html">Contact Us</a></li>
<li><a href="/about/background/">History and Philosophy &rarr;</a></li>
<li><a href="/policy/permission.html">Permissions and License</a></li>
<li><a href="/about/background/">History &amp; Philosophy</a></li>
<li><a href="/policy/permission.html">Permissions &amp; License</a></li>
<li><a href="/policy/privacy_policy.html">Privacy Policy</a></li>
<li><a href="/policy/terms_of_use.html">Terms of Use</a></li>
</ul>
</li>
<li><a href="/help/">Help</a>
<ul class="hidden">
<li><a href="/help/">All help topics &rarr;</a></li>
<li><a href="/help/copyright.html">Copyright Procedures</a></li>
<li><a href="/help/errata.html">Errata, Fixes and Bug Reports</a></li>
<li><a href="/help/file_formats.html">File Formats</a></li>
<li><a href="/help/faq.html">Frequently Asked Questions</a></li>
<li><a href="/policy/">Policies &rarr;</a></li>
<li><a href="/help/public_domain_ebook_submission.html">Public Domain eBook Submission</a></li>
<li><a href="/help/submitting_your_own_work.html">Submitting Your Own Work</a></li>
<li><a href="/help/mobile.html">Tablets, Phones and eReaders</a></li>
<li><a href="/attic/">The Attic &rarr;</a></li>
</ul>
</li>
<li><a href="/ebooks/">Search and Browse</a>
<li><a href="/ebooks/">Search &amp; Browse</a>
<ul class="hidden">
<li><a href="/ebooks/">Book Search</a></li>
<li><a href="/ebooks/bookshelf/">Bookshelves</a></li>
@ -45,6 +30,22 @@
</li>
<li><a href="/donate/">Donate</a></li>
<li><a href="/help/">Help</a>
<ul class="hidden">
<li><a href="/help/public_domain_ebook_submission.html">Public Domain eBook Submission</a></li>
<li><a href="/help/submitting_your_own_work.html">Submitting Your Own Work</a></li>
<li><a href="/help/">All help topics</a></li>
<li><a href="/help/copyright.html">Copyright Procedures</a></li>
<li><a href="/help/errata.html">Errata, Fixes &amp; Bug Reports</a></li>
<li><a href="/help/file_formats.html">File Formats</a></li>
<li><a href="/help/faq.html">Frequently Asked Questions</a></li>
<li><a href="/policy/">Policies</a></li>
<li><a href="/help/mobile.html">Tablets, Phones &amp; eReaders</a></li>
<li><a href="/attic/">The Attic</a></li>
</ul>
</li>
</ul>
<div class="searchbox">

2
gutenberg/nav.css
View File

@ -3,6 +3,7 @@ nav {
background-color:#EDDAB7;
color:#000000;
left: 0;
/*overflow:scroll;*/
padding: 0 10vw 0 0;
position: fixed;
right: 0;
@ -159,6 +160,7 @@ nav .donate a:hover{
nav {
height:auto;
font-size:12px;
position:absolute;
}
nav ul {
position: static;

66
site/help/new_website.md
View File

@ -24,6 +24,8 @@ Goals for the website redesign and back-end updates include:
## How to provide input, fixes and suggestions
Please first check below in case your suggestion is already being worked on.
### General reporting of errors
First, if you find a error, typo, etc. within an eBook you can report is using the [regular mechanisms](/help/errata.html). The eBooks themselves are exactly the same (i.e., the exact same files), whether you are looking at the development site or the main site.
@ -32,7 +34,7 @@ If you are not sure how to report a problem you find, it's fine to just email th
### Generated formats
A new version of [ebookmaker](https://github.com/gutenbergtools/ebookmaker) went into production in late December 2019. This is what creates our EPUB and MOBI (Kindle) formats. You can run it yourself on the PGLAF upload portal's [ebookmaker test page](https://ebookmaker.pglaf.org).
A new version of [ebookmaker](https://github.com/gutenbergtools/ebookmaker) went into production in late December 2019 and is being regularly updated. This is what creates our EPUB and MOBI (Kindle) formats. You can run it yourself on the PGLAF upload portal's [ebookmaker test page](https://ebookmaker.pglaf.org).
If you find problems with the format of the generated formats, let us know. The ebookmaker program is under continuous development, and as it is improved we are gradually re-generating all 60,000+ eBooks.
@ -66,45 +68,45 @@ It is especially important that we can understand what you are experiencing, and
Eventually, we hope to retire much or all of the current Project Gutenberg [mobile site](http://m.gutenberg.org), because it does not have anyone maintaining it, and it lacks much of the functionality and content of the main site.
## Known issues
* Some pages are not yet ported. This includes the Michael Hart eulogy, and a few pages that are outdated or deemed less important. If you find a page that isn't ported, and should be, please let us know.
* Bookshelves are not implemented on the new site yet.
* The links in the bibrec tabs for landing pages for eBooks should all work, but they go to a mixture of static and dynamic pages. Links to "also" and "locss" might not be working.
* The [autocat3](https://github.com/gutenbergtools/autocat3) program handles search, and also generates landing pages. There are probably some remaining problems with how results are displayed, or possibly with wrong links in bibrec tabs. If you find a problem, please send the exact link or search you used, so we can replicate and fix. Also note that autocat3 presents results in HTML 4, with somewhat different headers and without customization for mobile/smaller viewers. The rest of the site is in HTML5.
* Some "responsive" aspects of the site are not quite right, especially on smaller screens. We hope to fix these with improved CSS. Bottom-most pop-up menus (top of each page) are not reachable with short screens, and spacing between menu items isn't ideal.
* Translated pages will **not** be ported. The www.gutenberg.org site has always been written in English, and in the past there was some capability of hosting pages translated into other languages. However, this was never adequately maintained, and has resulted in outdated and unmaintained content in non-English. Instead, those wishing a translated site can now copy the structure and English contents from the github pages, and make their own website.
1. Some pages are not yet ported. This includes the Michael Hart eulogy, and a few pages that are outdated or deemed less important. If you find a page that isn't ported, and should be, please let us know.
2. Bookshelves are not implemented on the new site yet.
3. The links in the bibrec tabs for landing pages for eBooks should all work, but they go to a mixture of static and dynamic pages. Links to "also" and "locss" might not be working.
4. The [autocat3](https://github.com/gutenbergtools/autocat3) program handles search, and also generates landing pages. There are probably some remaining problems with how results are displayed, or possibly with wrong links in bibrec tabs. If you find a problem, please send the exact link or search you used, so we can replicate and fix. Also note that autocat3 presents results in HTML 4, with somewhat different headers and without customization for mobile/smaller viewers. The rest of the site is in HTML5.
5. Some "responsive" aspects of the site are not quite right, especially on smaller screens. We hope to fix these with improved CSS. Bottom-most pop-up menus (top of each page) are not reachable with short screens, and spacing between menu items isn't ideal.
6. Translated pages will **not** be ported. The www.gutenberg.org site has always been written in English, and in the past there was some capability of hosting pages translated into other languages. However, this was never adequately maintained, and has resulted in outdated and unmaintained content in non-English. Instead, those wishing a translated site can now copy the structure and English contents from the github pages, and make their own website.
## Issues being considered or investigated
These are mostly from reports that still need consideration, or might have some different approaches that need to be assessed:
### UI Related Issues
1. UI/Search: Search output order seems random.**Status: Defer. Search is handled by PostgreSQL, and unchanged from the current site. We will look into a different search implementation, for the future..**
2. autocat3/Search: Advanced Search, Author: "Agatha Christie" and "Ernest Hemingway": the two searches give a very different layout. **Status: Investigating.**
3. UI: Should the Search and Browse menu item be "Search & Browse" (it's common to use & in menus) and could the dropdown include Recently added? I'd be tempted to move the Bookshelves to just above offline calalogs. **Status: Being considered**
4. UI: "Donate" button and "Donate" link: do we need both? Should this be "appreciates your donations" rather "appreciates your donation?" **Status:Resolved. Donation Text is now underlined. Added text for direct donation. We will include some assessment of this in a forthcoming user survey.**
5. UI: The "Project Gutenberg" logo in upper left should be bigger. **Status: awaiting user testing.**
6. UI: Do you really need the Help and Information topic for the mainpage since you have a Help item going elsewhere in the site and this particular info isn't really key like the info about books and how tocreate the books. **Status: awaiting user testing.**
7. UI: Printing press in the logo looks like R2D2.**Status: Consider asking about this during user evaluation.**
8. UI/Search: Advanced Search has three different button styles. This is distracting for users.**Status: Consider changing; consider asking during user evaluation.**
9. UI: Perhaps the "Help" top menu item should be at the far right which is a common place for Help on menus. **Status: Being considered, might be part of user testing.**
10. UI/CSS: It's not clear what the meaning is of the --> arrow aftercertain drop-down menu items. Is it necessary? **Status: Being considered. Can we do a 2nd level pop-up menu?**
11. CSS: Your list elements in the text part of the page such as under "Find Free eBooks", are acting odd -- with the second lineof text wrapping under the bullet rather than being set off from it. **Status: Resolved.**
12. CSS: I wish the top menu bar and dropdowns used a sans serif font.Sans serif is more common for menus. Do you really need an underlineto appear under the text when you highlight a menu item? **Status: Resolved. Removed underline when hovering over menu items**
13. CSS: It might be worth considering using a san serif for headings andserif (as you are doing) for the main text on the pages. That's avery common typographic style. **Status: Resolved. Added Sans Serif fonts for menu and serif for rest of the page.**
14. CSS: How to make pop-up menu list display fit better? First, I couldn’t figure out how to get less spacing between the pop-up menu items (there is too much space before/after, and should be automatic spacing). Second, and more importantly, on a very small screen the menu items at the bottom of the list are unreachable (i.e., shrink your screen, and you’ll see they cannot be reached). Can this be some sort of scrollable list? **Status: Actively Investigating. Decreased min-width for less spacing between menu items.**
### HTML and autocat3 Related Issues
1. HTML: The site embeds Facebook and Twitter metadata to support rendering nicely on these platforms but doesn't embed structured data for the same effect on Google https://developers.google.com/search/docs/guides/intro-structured-data. **Status: All the headers need to be investigated and updated.** Note especially that autocat3, PHP and gutenbergsite all have different headers (autocat3 actually has multiple headers, via Genshi templates), and that only gutenbergsite is HTML5. So, we need to work towards a single header base that is valid, and suitable for HTML5 and HTML4.
2. HTML/autocat3: The session ID is included in the query parameters of Kindle and ePub download links. This could expose the session ID to intermediaries (caches, CDNs, ISPs). **Status: It's not clear whether or why this is necessary, since the downloads are to static files. It might be we can disable this.**
3. HTML: Content-Security-Policy (CSP) header is not being returned. Implementing a CSP goes a long way in mitigating XSS attacks https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP). **Status: Part of the header investigation mentioned above.**
4. autocat3/Search: On narrow screens, landing pages are squished and the footer disappears.
5. autocat3: JS and CSS source isn't minified leaking library names and versions https://snyk.io/vuln/search?type=npm&q=jquery. **Status: We plan to have no Javascript at all in the future. The only remaining Javascript is for switching between bibrec & download tabs on eBook landing pages such as https://dev.gutenberg.org/ebooks/11 .. we hope to instead to that in HTML5.**
6. HTTPD: The server cache (Varnish) is returned in the X-Varnish and Via headers https://www.cvedetails.com/vulnerability-list/vendor_id-12937/Varnish-cache.html. **Status: being investigated.**
7. Content: Add these links to the DP HTML documentation somewhere. **Status: Need to decide where to put the links.**
1. UI: The "Project Gutenberg" logo in upper left should be bigger. Printing press in the logo looks like R2D2. favicon.ico isn't as bold as it used to be. **Status: Under consideration, including during user testing.**
2. UI: Do you really need the Help and Information topic for the mainpage since you have a Help item going elsewhere in the site and this particular info isn't really key like the info about books and how to create the books. **Status: awaiting user testing.**
3. UI/Search: Advanced Search has three different button styles. This is distracting for users.**Status: Consider changing; consider asking during user evaluation.**
4. CSS: How to make pop-up menu list display fit better? First, I couldn’t figure out how to get less spacing between the pop-up menu items (there is too much space before/after, and should be automatic spacing). Second, and more importantly, on a very small screen the menu items at the bottom of the list are unreachable (i.e., shrink your screen, and you’ll see they cannot be reached). Can this be some sort of scrollable list? **Status: Investigating. Decreased min-width for less spacing between menu items.**
5. autocat3/Search: On narrow screens, landing pages are squished and the footer disappears.
6. CSS: Reordered "Help" menu text is messed u, wrapping improperly. **Status: Will fix.**
7. CSS: Problem with 'Help' menu showing overstruck text. **Status: Will fix.**
### Content issues
1. Redirect pages and updates to the 404 error are needed to help people find new pages, when using an older link (such as from MediaWiki). **Status: Will do before the main site changeover.**
2. Revise the Volunteer's FAQ (currently in "the attic" since it was outdated). **Status: The Whitewashers team is looking into this. The above links might do well in that FAQ, though the FAQ is geared towards solo producers.**
3. Content: Add these links to the DP HTML documentation somewhere. **Status: Need to decide where to put the links, and this depends on the Volunteer's FAQ mentioned just above.**
The Post-Processing FAQ --
https://www.pgdp.net/wiki/DP_Official_Documentation:PP_and_PPV/Post-Processing_FAQ
Easy Epub -- https://www.pgdp.net/wiki/DP_Official_Documentation:PP_and_PPV/Easy_Epub (It's a guide to how best to handle the HTML that goes through epubmaker to lead to passable epubs/mobis)
HTML Best Practices -- https://www.pgdp.org/~jana/best-practices/ (this was written a while back but DP tries to keep it up-to-date)
8. Revise the Volunteer's FAQ (currently in "the attic" since it was outdated). **Status: The Whitewashers team is looking into this. The above links might do well in that FAQ, though the FAQ is geared towards solo producers.**
### HTML, server and autocat3 Related Issues
1. HTML: The site embeds Facebook and Twitter metadata to support rendering nicely on these platforms but doesn't embed structured data for the same effect on Google https://developers.google.com/search/docs/guides/intro-structured-data. **Status: All the headers need to be investigated and updated.** Note especially that autocat3, PHP and gutenbergsite all have different headers (autocat3 actually has multiple headers, via Genshi templates), and that only gutenbergsite is HTML5. So, we need to work towards a single header base that is valid, and suitable for HTML5 and HTML4.
2. HTML/autocat3: The session ID is included in the query parameters of Kindle and ePub download links. This could expose the session ID to intermediaries (caches, CDNs, ISPs). **Status: It's not clear whether or why this is necessary, since the downloads are to static files. It might be we can disable this.**
3. HTML: Content-Security-Policy (CSP) header is not being returned. Implementing a CSP goes a long way in mitigating XSS attacks https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP). **Status: Part of the header investigation mentioned above.**
4. autocat3: JS and CSS source isn't minified leaking library names and versions https://snyk.io/vuln/search?type=npm&q=jquery. **Status: We plan to have no Javascript at all in the future. The only remaining Javascript is for switching between bibrec & download tabs on eBook landing pages such as https://dev.gutenberg.org/ebooks/11 .. we hope to instead to that in HTML5.**
5. HTTPD: The server cache (Varnish) is returned in the X-Varnish and Via headers https://www.cvedetails.com/vulnerability-list/vendor_id-12937/Varnish-cache.html. **Status: being investigated.**
### Search-related issues
Search functionality is provided by autocat3 and PHP, utilizing the back-end PostgreSQL database. This functionality is unchanged from the legacy site, though presentation/layout is different. Search improvements will be considered in the future.
1. UI/Search: Search output order seems random.**Status: Defer. Search is handled by PostgreSQL, and unchanged from the current site. We will look into a different search implementation, for the future.**
2. autocat3/Search: Advanced Search, Author: "Agatha Christie" and "Ernest Hemingway": the two searches give a very different layout. **Status: Defer. Search is handled by PostgreSQL, and unchanged from the current site. We will look into a different search implementation, for the future.**
*Most recently updated: January 20, 2020*
*Most recently updated: January 24, 2020*