Skip to content

Commit

Permalink
Documentation to release 1.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
maiconpinto committed Aug 9, 2017
1 parent 59a676f commit f3240e0
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public function beforeRender(Event $event)
}
```

After you enable the AdminLTEView class in the AppController.php file, you can overwrite any View file, only by creating the Plugin / AdminLTE / folder inside the Template folder.
After you enable the AdminLTEView class in the AppController.php file, you can overwrite any View file, only by creating the `Plugin/AdminLTE/` folder inside the `Template` folder.

For example, to overwrite the elements files, you must create them as follows:

Expand All @@ -119,6 +119,34 @@ For example:
1. `src/Template/Plugin/AdminLTE/Element/footer.ctp`
1. `src/Template/Plugin/AdminLTE/Admin/Element/footer.ctp`

In summary, the sequence of folders in which to check if that file exists is as follows:

1. `src/Template/Plugin/$theme/Plugin/$plugin/$prefix/`
2. `src/Template/Plugin/$theme/Plugin/$plugin/`
3. `src/Template/Plugin/$theme/$prefix/`
4. `src/Template/Plugin/$theme/`

For example, Let's say:

* $theme = 'AdminLTE';
* $plugin = 'SupportTicket';
* $prefix = 'Admin';

Therefore, the sequence that would verify the existence of a file, would be the following:

1. `src/Template/Plugin/AdminLTE/Plugin/SupportTicket/Admin/`
2. `src/Template/Plugin/AdminLTE/Plugin/SupportTicket/`
3. `src/Template/Plugin/AdminLTE/Admin/`
4. `src/Template/Plugin/AdminLTE/`

For the sake of clarity, let's say you have two environments separated by different prefixes: *Panel* and *Admin*.

The *Dashboard* enviroment has no menu and footer, but Admin has.

To solve this situation is very simple. You should create in the folder `src/Template/Plugin/AdminLTE/Panel/` the elements `aside/sidebar-menu.ctp` and` footer.ctp` with empty content.

However, for *Admin*, you should create `aside/sidebar-menu.ctp` in `src/Template/Plugin/AdminLTE/Admin/` or if you want to leave general, regardless of prefix, you should create in `src/Template/Plugin/AdminLTE/`. Similarly with the `footer.ctp`.

### Page debug

Added link to default page of CakePHP.
Expand Down

0 comments on commit f3240e0

Please sign in to comment.