Getting Started

An installation of this module can be done in any existing Drupal 8/9 site or on a fresh installation likewise. Just install it via:

composer require 'drupal/digital_signage_framework:<version>

After the successful installation, just enable the module by drush en digital_signage_framework.

Now it is time to take a look at some basic configuration. Go to Admin -> Configuration -> Web Services -> Digital Signage. Basically you just have to add a PlantUML location URL  to generate the sequence diagram for the schedule. The rest can be left with defaults. See all general configuration options described here. 

Next we want to visit the Schedule tab. Here are some options for generating a schedule. This module provides some defaults, which should be sufficient for the moment. If you want to know more, visit our configuration page.

To see results as fast as possible for getting some first expressions, we recommend to install the submodules this package provides:

• Custom Platform: drush en digital_signage_custom_platform
• Example: drush en digital_signage_example

After this installations it only takes a few steps to see really good results.

1. Go to Content-> Devices. 
2. Push the button Synch all Devices. Now you can see devices provided either from the module Example and from Custom
3. (optional) Go to Admin -> Configuration -> Web Services -> Digital Signage. Here you find the tab Custom Platform to add more devices described here.
4. Now in a Content Type, like Basic Page, add the display mode Digital signage landscape and configure the items you want to display.
5. Add a content and enable it for publishing in the section for Digital Signage
6. Add another content with a higher priority and one with a lower priority
7. Go to Content -> Devices and select one or more devices
8. Go to the option on the bottom and select Push Schedule and push Apply to selected item
9. Open an updated device
10. Click on Open diagram to see the playlist in a sequence diagram
11. Click on Open preview to see the result. You can watch the playlist running or switch between the slides with the arrow keys on the keyboard.

Now you can style the content by creating a CSS file and set it the configuration. To avoid redundancy with the stylings on your website, we recommend to use a preprocessor tool like SASS.

Now we also are able to push views to the created devices. Here we do the following:

1. Go to Structure -> Views and add a new view
2. Click Add... and select Digital Signage
3. Configure your view to fit your needs
4. Go to Content -> Computed content and make sure it is in the list
5. Configure this content for Digital Signage as you would do for any other content
6. Go to Content -> Devices and do the same as described above
7. See the result

So, this was a quick start to get in touch with the Digital Signage Framework. The next chapter to get a lot of more detailed information, is How to use it.