Skip to content

Commit

Permalink
Merge pull request #37 from art-institute-of-chicago/drift/remove-sha…
Browse files Browse the repository at this point in the history
…pe-face

Remove `shape_face`
  • Loading branch information
driftingly authored May 9, 2024
2 parents 29c572a + b3778f5 commit 4e04d38
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 53 deletions.
55 changes: 27 additions & 28 deletions USER-DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ content in Drupal 7, but this might be helpful for futher context.

In the upper left hand corner of the Drupal menu is a "Home" button. This button will
always take you back to the home screen. Next to the Home Button, you will find three menu
items highlighted in grey: Manage, Shortcuts, and your username.
Home is the most important screen. Here is a description of the management options you have access to:
items highlighted in grey: Manage, Shortcuts, and your username.
Home is the most important screen. Here is a description of the management options you have access to:

| Menu Item | Description |
|----------:|-------------|
Expand All @@ -37,7 +37,7 @@ The CMS is broken up into three content type categories: Activity Template, Artw
Theme. This section focuses on adding Artwork, which can then be linked to Themes. Once
linked, the back-end system will automatically output all required image sizes as needed
throughout various placements in the software interface and Journey Guide. One Artwork
can be added to multiple Themes, as required.
can be added to multiple Themes, as required.

### Create an Artwork

Expand All @@ -51,7 +51,7 @@ you are editing content before public opening, this is less crucial. If you are
edits after opening and this is live to the public, you’ll want to ensure "Published" is
left unchecked before saving, otherwise your changes will be shown in the front-end.
Navigate to the bottom of the page, and click the "Publishing options" tab and make your
selection.
selection.
5. Once a title is entered and you've selected your publishing preference, you may click
"Save," and can revisit this Artwork at any time to continue editing.
6. If you've created an Artwork by mistake or wish to delete it, you can easily access it
Expand All @@ -66,10 +66,10 @@ confirmation page you can either delete, or cancel and keep your Item.
1. Click "Home," then "Find Content," "Art by Theme," "Art," or "Search." A list will
appear of all existing content items. You can sort items by Title, Type, Author, or Date.
2. Select the Artwork you'd like to edit. You"ll be taken to that item's page in the CMS.
Click the "Edit" tab in the upper right corner.
Click the "Edit" tab in the upper right corner.
3. From here you have an array of fields and selection boxes. See the above table for
detailed explanations of the fields. Be sure to click "Save" when you’ve completed your
changes.
changes.
4. To add italics to any field, place `<em>` where you’d like italics to start, and `</em>` where you’d like italics to stop.

| Field | Description | Character Count/Field Specs |
Expand All @@ -91,26 +91,26 @@ changes.

## Themes

Themes can then be linked to Artworks that have been previously created. In addition to text and images of the artwork, designs will need to be created to populate the selector shape and Journey Guide.
Themes can then be linked to Artworks that have been previously created. In addition to text and images of the artwork, designs will need to be created to populate the selector shape and Journey Guide.

### Create or delete a Theme

1. Click "Manage," then "Content," then the "Add content" link.
2. Click the "Theme" link.
2. Click the "Theme" link.
3. A blank Theme format will appear. In order to save the Theme, a title is required
(see the following table for character count details).
4. Before clicking "Save," consider if you want this content published or not. If you
are editing content before public opening, this is less crucial. If you are making edits
after opening and this is live to the public, you’ll want to ensure "Published" is left
unchecked before saving, otherwise your changes will be shown in the front-end. Navigate
to the bottom of the page, and click the "Publishing options" tab and make your
selection.
selection.
5. Once a title is entered and you've selected your publishing preference, you may click
"Save," and can revisit this Theme at any time to continue editing.
"Save," and can revisit this Theme at any time to continue editing.
6. If you've created a Theme by mistake or wish to delete it, you can easily access it
again using the upper navigation. Click "Dashboard," then "Content." A list will appear
of all existing content items. You can sort items by Title, Type, Author, or Date. If
you wish to edit, select "edit." If you wish to delete, click "delete." A confirmation
you wish to edit, select "edit." If you wish to delete, click "delete." A confirmation
will appear. Be sure you wish to delete, as this action **cannot be undone**! From the
confirmation page you can either delete, or cancel and keep your Theme.

Expand All @@ -119,40 +119,39 @@ confirmation page you can either delete, or cancel and keep your Theme.
1. Click "Dashboard," then "Content." A list will appear of all existing content items.
You can sort items by Title, Type, Author, or Date. Select the Theme you’d like to edit.
You'll be taken to the Theme page in the CMS. Click the "Edit" tab in the upper right
corner.
corner.
2. From here you have an array of fields and selection boxes. See below for details. Be
sure to click "Save" when you’ve completed your changes.
sure to click "Save" when you’ve completed your changes.
3. To add italics to any field, place `<em>` where you’d like italics to start, and
`</em>` where you'd like italics to stop.
`</em>` where you'd like italics to stop.

### Edit Artworks by Theme

After creating your Themes and linking your Artworks, you may want the ability to edit
and sort Artworks by Themes. There are two ways to do this.
After creating your Themes and linking your Artworks, you may want the ability to edit
and sort Artworks by Themes. There are two ways to do this.

#### Approach One – At the Theme Level

1. Select the theme you wish to edit, and go to the "View" tab.
1. Select the theme you wish to edit, and go to the "View" tab.
2. Scroll down to the prompt section containing the Artwork you want to edit. Hover over
the upper right corner of the image, and an edit gear will appear.
the upper right corner of the image, and an edit gear will appear.
3. Select the edit gear. A drop down menu will appear with the option to either Edit or
Delete.
Delete.
4. Select Edit. You will be taken directly to that Artworks page and can edit from
there.
there.

#### Approach Two – Sorting Shortcut
#### Approach Two – Sorting Shortcut

1. Select the shortcuts tab in the main menu.
2. A drop down menu will appear with the option "Art by Theme." Select this option.
1. Select the shortcuts tab in the main menu.
2. A drop down menu will appear with the option "Art by Theme." Select this option.
3. You will be shown a list of Artworks sorted by Theme and Prompts. From here you can
view or edit Artworks directly.
view or edit Artworks directly.


| Field | Description | Character Count/Field Specs |
|-------|-------------|-----------------------------|
| Title | Theme title, as it will appear on the Theme selector page and subsequent pages as users build their Journey Guide. | Maximum 23 characters. |
| Theme Intro | Theme subtitle, as it will appear on Theme selector page. | Maximum 226 characters. |
| Shape Face (image uploader) | Animated Theme icon as it will appear on the Theme selector shape. | N/A |
| Icon (image uploader) | Simplified Theme icon as it will appear on subsequent pages as users build their Journey Guide. | N/A |
| Guide Cover Art (image uploader) | Customized art cover that appears on the Journey Guide to correspond with the selected Theme. | N/A |
| Journey Guide Cover Title | Customized text that appears on the Journey Guide to correspond with the selected Theme. To correspond with a users name, ex: [User]’s [Journey Guide Cover Title] | Maximum 25 characters. |
Expand All @@ -165,11 +164,11 @@ view or edit Artworks directly.

Activity Templates can be linked to Artworks. Once linked, the back-end system will
automatically output all required image sizes and colors for both the Kiosk and Home
Companion Journey Guides. One Activity Template can be added to multiple Artworks.
Companion Journey Guides. One Activity Template can be added to multiple Artworks.

This distribution has created five activity templates created by Belle & Wissel Co.
Creating a new Activity Template does require some hard coding in the system, so new
templates cannot be added without an update to the build.
templates cannot be added without an update to the build.

## Other General Tools

Expand All @@ -180,7 +179,7 @@ necessary for data entry.

When adding or editing content, standard options appear at the bottom of each
page. While not necessary for content editing, they may be used to help track changes or
add comments and questions for the team.
add comments and questions for the team.

| | |
|---|---|
Expand Down
5 changes: 0 additions & 5 deletions app/Http/Controllers/Twill/ThemeController.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,6 @@ public function getForm(TwillModelContract $model): Form
->translatable(),
]),
Fieldset::make()->title('Media')->id('media')->fields([
Medias::make()
->name('shape_face')
->label('Shape Face')
->fieldNote('Animated Theme icon as it will appear on the Theme selector shape.'),

Medias::make()
->name('icon')
->label('Icon')
Expand Down
7 changes: 0 additions & 7 deletions app/Http/Requests/Twill/ThemeRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@ public function rulesForCreate()
public function rulesForUpdate()
{
return $this->rulesForTranslatedFields([
'medias.shape_face' => function (string $attribute, mixed $value, Closure $fail) {
$image = $value[0] ?? null;

if ($image['width'] !== 2888) {
$fail('The shape face must be 2888px wide.');
}
},
'medias.icon' => function (string $attribute, mixed $value, Closure $fail) {
$image = $value[0] ?? null;

Expand Down
2 changes: 1 addition & 1 deletion app/Http/Resources/ThemeResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public function toArray(Request $request): array
'id' => $this->id,
'title' => $this->title,
'intro' => $this->intro,
'shapeFace' => $this->getImage('shape_face'),
'shapeFace' => null,
'icon' => $this->getImage('icon'),
'guideCoverArt' => $this->getImage('cover'),
'guideCoverArtHome' => $this->getImage('cover_home'),
Expand Down
11 changes: 0 additions & 11 deletions app/Models/Theme.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,6 @@ class Theme extends Model implements Sortable
];

public $mediasParams = [
'shape_face' => [
'default' => [
[
'name' => 'default',
'minValues' => [
'width' => 2888,
'height' => 2789,
],
],
],
],
'icon' => [
'default' => [
[
Expand Down
1 change: 0 additions & 1 deletion database/seeders/TestSeeder.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ public function run(): void

$this->addTranslations($theme, ['title', 'intro', 'journey_guide']);

$this->addImage($theme, base_path('tests/data/images/theme-shape-face.png'), 'shape_face');
$this->addImage($theme, base_path('tests/data/images/theme-icon.png'), 'icon');
$this->addImage($theme, base_path('tests/data/images/theme-cover.png'), 'cover');
$this->addImage($theme, base_path('tests/data/images/theme-cover-home.png'), 'cover_home');
Expand Down

0 comments on commit 4e04d38

Please sign in to comment.