Displays screenshots of rendered templates when selecting a page type.
This package is auto-updated.
Last update: 2021-08-31 00:30:27 UTC
This module makes creating pages in the CMS better. In like, every single way.
composer require unclecheese/silverstripe-page-gallery
cd silverstripe-page-gallery && npm install
When adding a page in the CMS, the user is typically forced to parse a long list of ambiguous, developer-defined PHP class names in order to choose the page type that he or she wants. While the API offers configurations like
$description, it can still be difficult to signal to a content editor exactly what a given page is used for.
I mean, really,
ConferenceEventPricingCategoryHolder? Don't do me like that, bro.
Stop the madness. Let's just use auto-generated screenshots.
In addition to providing actual screenshots of each page type, the UI filters out page types that cannot be created in the section. Without this module, all of those page types are interpolated into the list, creating unnecessary visual noise and head-spinniness.
Just run the task:
A simple PhantomJS based library will take it from there.
So you don't want that
PlainTextPasswordPage getting a screenshot? Just add it to the
UncleCheese\PageGallery\PageGalleryBuilder: exclude: - SomePage
By default, the screenshot task will get the last edited instance of a
SiteTree object with
ClassName equal to the page type. For more granular control, use
UncleCheese\PageGallery\PageGalleryBuilder: instance_map: Page: 'about-us' EventPage: 123
You can identify an instance by link or by ID.
Configure the task:
UncleCheese\PageGallery\PageGalleryBuilder: # width of the browser taking the screenshot screen_width: 1200 # height of the browser taking the screenshot screen_height: 800 # don't create screenshots for these pages. exclude: - VirtualPage - RedirectorPage # If you have a preference on what page gets the screenshot, map it to a link or ID instance_map: Page: 'about-us' EventPage: 123 # Where the screenshots are saved. Recommend this is in source control project_screenshot_dir: 'mysite/images/screenshots'
There are also a few settings you can throw at the CMS UI.
PageGalleryUI: # width of the screenshot in the gallery image_width: 300 # height of the screenshot in the gallery image_height: 200 # When no screenshot exists, use this default image default_image: 'silverstripe-page-gallery/images/default.png'
- SilverStripe > 3.1
nodebinary must be in your PATH. (Hint: type
node -vto get the verdict on that. If you get bad news, it's exceedingly simple to rectify)
unclecheese/silverstripe-image-optionsetmodule. It's new in town.
Cause... talking to myself.
I think it makes sense to put them in a source-controlled part of your project, e.g.
mysite/images/screenshots, but this raises a few questions, particularly around the write permissions on your
mysite/ directory, and the consequences of writing to a source-controlled directory in a non-development environment.
assets/ might make sense in that case, but that has the reverse problem of making it difficult for a developer to generate them locally and move them into staging and production
assets/ directories, because they're typically controlled by the users.
Indeed. It would make sense if a dev environment could inject a Node based screenshot grabber, and a staging environment could use a web service like url2png, or what have you. The only issue with using a web service is that staging sites are often behind HTTP Auth.
Potentially we could create a temporary one just for the screenshot, fill it with dummy content, then delete it?
Ring Uncle Cheese.