CD2H gitForager

SciGaP/base-pga-theme

Name: base-pga-theme

Owner: Science Gateway Platform as a service

Description: Base Theme to fork and create customized themes

Created: 2017-02-03 16:59:57.0

Updated: 2017-02-03 18:18:09.0

Pushed: 2017-08-16 21:03:06.0

Homepage: null

Size: 9

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Theme Documentation ( Read before starting to work on your themes)

Steps to create your own theme:

1) First thing first, PGA themes use Bootstrap 3.x and Blade as its templating engine as a base for all UI Development. The capability to let users use another UI framework is being worked upon and would be available in the future. If users still want to use another UI framework, they could add it in theme header/footer and it will act as the overwriting entity on anything which Bootstrap has a hold on.

2) Copy /public/themes/base folder in the same 'themes' folder and rename it to your theme. Lets call this folder 'theme1' for the rest of the steps.

3) PGA Theme structure:

Below is how all UIs are layered in a theme.

-------------------------------
EME HEADER                     |
-------------------------------
A HEADER                       |
-------------------------------
A BODY (main content)          |
-------------------------------
A FOOTER                       |
-------------------------------
EME FOOTER                     |
-------------------------------

Folder 'Theme1' contains 4 folders:

Assets: All styling, scripts and image files can be kept here and accessed in theme pages using- {{ URL::to('/') }}/themes/{{Session::get('theme')}}/assets/ Users can create additional folders inside 'assets' for structuring purposes like css, js, img files.
Partials: All HTML blocks and pages which should be included in a theme can be added here. By default, this folder contains header.blade.php, footer.blade.php and template.blade.php and should NOT be deleted.
Layouts and Views: Additional folders to structure extra theme components and plugin layouts if any.

4) For a complex home page it is recommended that you separate out the styling for the home page from the rest of the theme. You can do this by creating a landingpage.blade.php file in the views folder. This landingpage.blade.php template, if it exists, will be displayed for the home page of the PGA and will be the only thing displayed as the home page. This gives the theme developer freedom to put anything at all into this landing page. This approach can be combined with a simple theme header and footer that will be shown in the PGA once logged in.

inside the landingpage.blade.php template use the urls /create and /login to link to the PGA Create Account and Login pages, respectively.
See https://github.com/SciGaP/siu-gateway-theme/blob/master/views/landingpage.blade.php for an example

THEME HEADER:

This is the space where Theme creaters can add their theme headers which would generally contain styles or links to styles, global navigation for a Scientific gateway having logo/s, links etc which would show across all pages on PGA.

All content for Theme Header can be added in theme1/partials/header.blade.php.

Additional pages other than the landing page can be created and linked to THEME header. The way to do that is add the page content to 'theme1/partials/' and can be referenced/linked from anywhere inside the theme pages with the link: '{{URL::to('/')}}/pages/page1' ( blade.php does not need to be written).

Sample Theme Header content:

Theme1