diff --git a/documentation/mothership-documentation.md b/documentation/mothership-documentation.md index 5ca8115..15e91fd 100644 --- a/documentation/mothership-documentation.md +++ b/documentation/mothership-documentation.md @@ -9,15 +9,15 @@ \/_/ #the Mothership -The mothership is a HTML5 basetheme that drop Drupals obscure love for wrapping everything into 2 divs & slapping on 3 css classes everywhere its possible. +The mothership is a HTML5 base theme that drop Drupal's obscure love for wrapping everything into 2 divs & slapping on 3 css classes everywhere its possible. This theme will NOT make your site look neat - but it will clean up the markup Drupal provides out of the box, provide settings to remove css classes in the markup. -This should make you daily work as a frontend developer much easier, and remove a lot of the frustration in plowing through the ton of unused css & markup. +This should make you daily work as a front end developer much easier, and remove a lot of the frustration in ploughing through the ton of unused css & markup. If you really like the markup & css options that Drupal Provides - This theme is probably not for you, and thats perfectly ok, this theme won't do anything for you. If you on the other hand cares about clean markup & css - This could be a good solution. # Basic Mothership plan: -The mothership dosnt want to be the theme for everything & everybody - This is a much a proof of concept & playground to push the limits & ways that we build Drupal Themes. +The mothership doesn't want to be the theme for everything & everybody - This is a much a proof of concept & playground to push the limits & ways that we build Drupal Themes. ### Fixing the Divitis @@ -29,14 +29,14 @@ No reason to load in classes that isn't need. `
` Change images directly in the markup is cumbersome - its now be in css. (css/mothership.css) @@ -51,10 +51,10 @@ As the Drupal8 platform is being developed & discussed The mothership will look for better implementations & will add them as we see fit. ### Quick & easy CSS resets. -Don't bring you own ;) 3 of the standard resets are included: the Eric meyer reset.css, html5 Doctor's reset & the normalizer outta the box. +Don't bring you own ;) 3 of the standard resets are included: the Eric Meyer reset.css, html5 Doctor's reset & the normalizer outta the box. ### Tons of Settings : / -So we don't end up breaking backwards compability with existing modules & functionality. - All the css fixes are quickly undone by changing the settings. +So we don't end up breaking backwards compatibility with existing modules & functionality. - All the css fixes are quickly undone by changing the settings. That means theres a lot of settings :( @@ -62,22 +62,27 @@ That means theres a lot of settings :( Motherships role is not to make it Pretty to Look at but pretty to work with - should work ### Fix everything thats wrong (™) -this is a tool for theme development for those that really cares about the markup & not quick n "easy" solutions & at the same time digg through the drupalcore,clean up so it can be easy for new frontend developers to use drupal & less wtf why is that div doing there. +this is a tool for theme development for those that really cares about the markup & not quick n "easy" solutions & at the same time dig through the Drupal core, clean up so it can be easy for new front end developers to use Drupal & less wtf why is that div doing there. ##Whats in there: * documentation -This file * mothership -the mothership base theme - where the cleanup happens * mothershipstark -For testing purpose - yup gonna move it out someday * NEWTHEME -a Vanilla theme based on mothership * README.txt +This file +* mothership +the mothership base theme - where the cleanup happens +* mothershipstark +For testing purpose - yup gonna move it out someday +* NEWTHEME +a Vanilla theme based on mothership +* README.txt * resources -Graphic files for the screenshots & icons * tema +Graphic files for the screenshots & icons +* tema am example theme thats pretty soon it gonna be moved to its own project. ##Mothership takes over the markup -The Mothership is a basetheme so you can build themes on top of it & inherit all the glorious cleanup that the mothership brings you. +The Mothership is a base theme so you can build themes on top of it & inherit all the glorious cleanup that the mothership brings you. themename.info **base theme = mothership ** @@ -98,11 +103,11 @@ The theme now uses the default settings that mothership uses. #Settings The heart of the mothership is the markup & css cleaning. -If every class & wrapper div was removed it would end up with a lot of Drupals basic functionality that now simply didn't work. -You would have to do a lot of work every time you had to identify any element on the site (actually back tracking into the center of drupal & you would never come back from) +If every class & wrapper div was removed it would end up with a lot of Drupal's basic functionality that now simply didn't work. +You would have to do a lot of work every time you had to identify any element on the site (actually back tracking into the centre of Drupal & you would never come back from) So to make it a bit easier to remove, or add, class's & markup that we might need all this is done in the settings. -These settings will be global in you drupal theme, but as always you can overwrite these with theme functions or .tpl files. +These settings will be global in you Drupal theme, but as always you can overwrite these with theme functions or .tpl files. Look in the theme suggestion for those (more about that in the theme development settings) ##Theme Development @@ -118,7 +123,7 @@ when you get tired of doing _drush cc all_ day Thank you zen theme for providing this cool little feature **.test class** -It can be very practical during developerment to have a test class in the body tag for showing a grid.png etc, so you can quickly remove it again if so needed. +It can be very practical during development to have a test class in the body tag for showing a grid.png etc, so you can quickly remove it again if so needed. body.test{ background:pink } @@ -126,7 +131,7 @@ body.test{ background:pink } ##External Libraries ![image](8-libraries.png) -Quick & easy loading of libraries that can be very helpfull +Quick & easy loading of libraries that can be very helpful **modernizr2** This will load modernizr2 with all its glory from a CDN @@ -144,11 +149,11 @@ Usually a Module comes with a couple of files containing defaults & other goodie ###Reset options -Quick options for the lazy themer choose you favorite css reset: +Quick options for the lazy themer choose you favourite css reset: ![image](cssfile-reset.png) ###BAT Cleanup & CSS Files Removal -In Drupal seven the BAT naming scheme were introduced - which splits up the css files for a module into 3 diffent files: +In Drupal7 the BAT naming scheme were introduced - which splits up the css files for a module into 3 different files: 1. modulename.**base**.css the bare minimum for the module to function @@ -162,7 +167,7 @@ core css files are copied over & split up for quick cleanup. In Drupal8 theres a huge effort to get this in as clean n mean as possible. for -* [Drupal HTML5 landing page](http://drupal.org/html5) +* [Drupal HTML5 landing page](http://Drupal.org/html5) * [mortendk's post about BAT](http://morten.dk/blog/bat-naming-scheme) ![image](cssfile-bat.png) @@ -174,12 +179,12 @@ In the future more core modules will be split and added to the mothership ####Stylestripper Not all modules do the BAT thing (yet!) -To remove a file you can instead add the path to it in the stripper (inspired by the drupal6 module: style stripper) +To remove a file you can instead add the path to it in the stripper (inspired by the Drupal6 module: style stripper) ![image](cssfile-stripping.png) ### Default -Removing all the styles can be a problem, so to make it easier for us theres to files to look at for possible inclusion +Removing all the styles can be a problem, so to make it easier for us theres to files to look at for possible inclusion ![image](cssfile-default.png) Default css have basic Drupal stuff in it @@ -259,12 +264,12 @@ More info about the viewport: #Requirements Mothership don't have any hardcoded variable inside the tpl files. -It simply dosn't make any sense that everything in Drupal is a block, but the tabs, messages, search, rss feeds, titles, logo & menus are all hardcoded in the page.tpl +It simply doesn't make any sense that everything in Drupal is a block, but the tabs, messages, search, rss feeds, titles, logo & menus are all hardcoded in the page.tpl ###Blockify page.tpl.php in mothership has cleaned out all the hardcoded variables To enable tabs, messages, search, rss feeds, titles, logo & menus (phew) -[Download Blockify ](http://drupal.org/project/blockify) +[Download Blockify ](http://Drupal.org/project/blockify) @@ -278,7 +283,22 @@ including the awesome menu-block module markup & css cleaned up (the same as in Drupal8) * book-navigation.tpl.php -* aggregator-item.tpl.php * block.tpl.php * comment-wrapper.tpl.php * comment.tpl.php * eva-display-entity-view.tpl.php * field.tpl.php * html.tpl.php * menu-block-wrapper.tpl.php * node--nodeblock.tpl.php * node.tpl.php * page.tpl.php * region.tpl.php * taxonomy-term.tpl.php * views-view-list.tpl.php * views-view.tpl.php +* aggregator-item.tpl.php +* block.tpl.php + +* comment-wrapper.tpl.php +* comment.tpl.php +* eva-display-entity-view.tpl.php +* field.tpl.php +* html.tpl.php +* menu-block-wrapper.tpl.php +* node--nodeblock.tpl.php +* node.tpl.php +* page.tpl.php +* region.tpl.php +* taxonomy-term.tpl.php +* views-view-list.tpl.php +* views-view.tpl.php ###html.tpl @@ -323,7 +343,7 @@ Some of the things that are going into the theme layer in Drupal8 is gonna be ba ##known Problems ###Mothership Dominates LESS module -Mothership doesn't make sweet love to the LESS module. They both do their magick with the $css and there can only be one actually mothership brutly overwrites whatever the less module wanna do +Mothership doesn't make sweet love to the LESS module. They both do their magic with the $css and there can only be one actually mothership brutally overwrites whatever the less module wanna do This is because LESS module wanna compile the .less files into .css files as the $css is built & mothership tries to clean out all the crap *ahem* @@ -333,16 +353,16 @@ A workaround is to begin to do the compiling locally with code kit (was less.app ## Bug Reports etc Just to make it clear the Mothership is **NEVER** to blame! -Its always Drupals fault (this haven't been confirmed 101% yet by the @drupalthruth though) -… if it should happend that theres actually a bug somewhere, please use the mothership issueque for this. -I won't answer emails about it only in the issueque +Its always Drupals fault (this haven't been confirmed 101% yet by the @Drupalthruth though) +… if it should happen that theres actually a bug somewhere, please use the mothership issue queue for this. +I won't answer emails about it only in the issue queue -[Mothership issues](http://drupal.org/project/issues/mothership) +[Mothership issues](http://Drupal.org/project/issues/mothership) ## Todo This is a list of things that are on the table for the next couple of releases. -other things that are missing post it in the [issueque](http://drupal.org/project/issues/mothership) +other things that are missing post it in the [issueque](http://Drupal.org/project/issues/mothership) * taxonomy classnames in * Clearfix removal to the max * split out TEMA into its own separate theme @@ -357,7 +377,7 @@ other things that are missing post it in the [issueque](http://drupal.org/projec #History -The mothership project was startet based on sheer frustration of the huge amount of markup & css that drupal puts outta the box. +The mothership project was started based on sheer frustration of the huge amount of markup & css that Drupal puts outta the box.