Plugin Directory

Changeset 2576610


Ignore:
Timestamp:
08/02/2021 04:32:07 PM (5 years ago)
Author:
aurelienpierre
Message:

improve readme

File:
1 edited

Legend:

Unmodified
Added
Removed
  • photographers-galleries/trunk/readme.txt

    r2576587 r2576610  
    1111Enhance your galleries with HTML5 responsive `figure` and present them with a  lightweight CSS3 carousel or exhibition mode that fills the gap between a digital presentation and a real-life exhibition.
    1212
    13 [Demo](https://photo.aurelienpierre.com/photographers-galleries-demo/)
    1413
    1514== Description ==
    1615
     16= What ? =
     17
     18This is a lightweight plugin to display dynamic or static galleries on posts and pages with minimal overhead and using only native WordPress media.
     19
     20Main features:
     21
     221. enable responsive images sizes (visitors get served the closest image size to their actual display resolution),
     232. enable custom taxinomies, tags, comments, author, comments for media attachments,
     243. make images queryable by tags, comments, taxinomies, etc. to display dynamic galleries from a shortcode,
     254. provide shortcode wrappers for default WordPress galleries to enable advanced layouts (carousel, exhibition, no caption, etc.),
     265. style default column galleries in a masonry way,
     276. add EXIF metadata in media admin view,
     287. fully responsive (height and width),
     298. **provide elegant, minimalist looks that put emphasis on image content first and never crop images to fit in an arbitrary layout.**
     30
     31The look is inspired by art books and museums exhibitions, meant to allow a flawless and non-intrusive full-screen experience, so you can design your website as a webapp.
     32
     33
     34= Why ? =
     35
    1736Most fancy gallery plugins will add their gallery manager on top of WordPress, which already has one… Then, they will crop images to fit within their fancy layout. Unfortunately, if you are an artist, the way you composed and framed your picture is no accident and should be honored by whatever display system you use. After all that, they will add an awful bloat of jQuery madness that will put a hole in your [Page Speed](https://developers.google.com/speed/pagespeed/insights/) score and kill your [loading time](https://tools.pingdom.com/). Finally, they will distract visitors from your content with all their fancy effects that make your CPU overheat for nothing. Picture-based websites were already heavy, these will make sure to give them the final blow...
    1837
    1938We need better.
    2039
    21 Photographers galleries extends native WordPress galleries with EXIF support and taxonomies, and make them query-able to display truly dynamic galleries. It uses 90% of built-in browser technologies (pure CSS and HTML), with only a bit of native Javascript to extend them (no jQuery or additional lib dependency). This ensures fast loading, fast execution, and will take advantage of hardware-accelerated animations. Overall, you get carousels and exhibitions with a small performance footprint, which is more energy-efficient but also snappier nd better looking than full-on Javascript animations.
    22 
    23 For performance, it loads minified CSS and Javascript, only on the pages that actually make use of galleries (auto-detected). It's fast, minimalist, simple, robust, and good for your SEO (which is now a factor in [Google Page Rank](https://tools.pingdom.com/)).
    24 
    25 The look is inspired by art books and museums exhibitions, meant to allow a flawless and non-intrusive full-screen experience, so you can design your website as a webapp.
    26 
    27 
    28 = Quick features overview =
    29 
    30 * Ready to use with caching, minification and lazy loading plugins : WP Super Cache, W3 Total Cache, WP Rocket, etc.,
    31 * Compatible with Jetpack tiled galleries and every lightbox plugin, consistent with Jetpack tiled galleries styling,
    32 * Fully responsive (width and height),
    33 * The JS weighs only 4.7 kB, and the CSS 7 kB. JS is loaded in page footer and supports deferring.
    34 * Theme-agnostic design, classy minimalist look.
     40
     41= How ? =
     42
     43* Use only built-in browser technologies (CSS, HTML, and native Javascript) to extend browser native features.
     44* Don't use jQuery or additional bloatware lib that slows down page loading, creates compatibility nightmares and may not be hardware-accelerated.
     45* Load minified JS and CSS, on-demand (only on pages that use them), in footer and with defer support.
     46* Compatible with caching, minification, CDN and lazy loading (tested with WP Rocket).
     47* Compatible with lightboxes plugins.
     48* Only extends core WordPress features, for better security and maintainability.
     49
     50The JS weighs only 5.2 kB, and the CSS 7.2 kB.
     51
     52
     53== Features ==
     54
    3555
    3656= Attachements improvements =
     
    105125* author credit.
    106126
    107 == Caveats ==
    108 
    109 Using native WordPress galleries, Photographers Galleries need to overwrite theme styling, which might still compete with it. Some CSS tuning might be necessary to fix corner-cases.
    110127
    111128== Installation ==
     
    216233* `custom`, etc : you can create your own CSS looks by setting `look="your-name"` in the shortcode, and style the CSS selector `.pg-exhibition-wrapper .look-your-name`.
    217234
    218 == Other notes ==
     235
     236== Technical details ==
     237
    219238
    220239= Configuring Media Library Assistant for PG =
     
    2242431. For "Galleries", "Locations", "Models", check all the checkboxes of the line
    2252441. Strings are ready to translate
     245
     246
     247= Caveats =
     248
     249Using native WordPress galleries, Photographers Galleries need to overwrite theme styling, which might still compete with it. Some CSS tuning might be necessary to fix corner-cases.
     250
    226251
    227252== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.