alchemy-usermanual 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a63300d0871805fe28355e205b443efeaccc15e
+  data.tar.gz: 062b5b47a887748e06cb5c941a37da1a0cac8719
+SHA512:
+  metadata.gz: a08b62140781d8b20147693e29f40db3cde20418f9d33bf6190424a200d1bf07ff3555bf96008da5719b99e9cd12c84d610bc9dbbd7f7d142f1862409d1b4b56
+  data.tar.gz: d8ef0aed3655454b2fde0039b402dedbbf94b0ffa39c5c30733c694e721f021b92921c7b0836b19ba7e55b61c0ec237ab4e742ab99e65ad51092e261996d1177

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle
+.rspec
+.ruby-version
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/index/
+spec/dummy/.sass-cache
+Gemfile.lock
+/coverage

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master
+script: rake
+env:
+  - DB=mysql

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'sqlite3'
+end
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2010-2013, magic labs GmbH, Hamburg Germany
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+  Neither the name of the magic labs GmbH nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,65 @@
+## On-site user manual for Alchemy CMS
+
+[![Build Status](https://secure.travis-ci.org/magiclabs/alchemy-usermanual.png)](http://travis-ci.org/magiclabs/alchemy-usermanual) [![Coverage Status](https://coveralls.io/repos/magiclabs/alchemy-usermanual/badge.png)](https://coveralls.io/r/magiclabs/alchemy-usermanual) [![Code Climate](https://codeclimate.com/github/magiclabs/alchemy-usermanual.png)](https://codeclimate.com/github/magiclabs/alchemy-usermanual)
+
+The version 0.9.x is used to work with [Alchemy CMS 2.7-stable](https://github.com/magiclabs/alchemy_cms/tree/2.7-stable)
+
+The alchemy-usermanual gem reads your `page_layouts.yml` and `elements.yml` and wraps all the interesting stuff into a module rendered in the admin-frontend of your Alchemy CMS driven application.
+
+Users that are logged in to Alchemy can read through the self-explaining website configuration.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+~~~
+gem 'alchemy-usermanual', '~> 0.9'
+~~~
+
+And then run `bundle install` on your terminal.
+
+
+## Usage
+
+You just need to bundle the gem with your application. Then the user manual will be available in the Alchemy admin-frontend.
+
+By default translated informations of your page_layouts and elements are presented to the user.
+If you like to extend these informations with individual descriptions, you can store these translatable informations as *hints* in your `page_layouts.yml` and `elements.yml` files.
+
+*Example 1 (hint for a page_layout)*
+
+~~~
+# /config/alchemy/page_layouts.yml
+- name: product_detail
+  hint: true
+  elements: [...]
+
+# /config/locales/en.yml
+en:
+  alchemy:
+    page_layout_hints:
+      product_detail: "This page template is used for presenting all the details of one certain product... You can write a full description of what the page template is used to and what the user should consider when using it."
+~~~
+
+*Example 2 (hint for an element)*
+
+~~~
+# /config/alchemy/elements.yml
+- name: product_detail
+  hint: true
+  elements: [...]
+
+# /config/locales/en.yml
+en:
+  alchemy:
+    element_hints:
+      product_video: "This element is used to play the youtube video of your product... You can write a full description of what the element is used to and what the user should consider when using it."
+~~~
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AlchemyUserManual'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => ['alchemy:spec:prepare', :spec]
+
+Bundler::GemHelper.install_tasks
+
+namespace :alchemy do
+  namespace :spec do
+
+    desc "Prepares database for testing Alchemy"
+    task :prepare do
+      system 'cd spec/dummy && RAILS_ENV=test bundle exec rake db:drop db:create alchemy:prepare && cd -'
+    end
+
+  end
+end

data/alchemy-usermanual.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require "alchemy/user_manual/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "alchemy-usermanual"
+  spec.version       = Alchemy::UserManual::VERSION
+  spec.authors       = ["Robin Böning"]
+  spec.email         = ["rb@magiclabs.de"]
+  spec.description   = "This gem adds a user manual module to your alchemy cms driven application."
+  spec.summary       = "This gem adds a user manual module to your alchemy cms driven application."
+  spec.homepage      = "http://magiclabs.de"
+  spec.license       = "BSD New"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_dependency "alchemy_cms", ['~> 2.7.0']
+  spec.add_dependency "redcarpet"
+  spec.add_dependency "github-markdown", "~> 0.6.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec-rails"
+end

data/app/assets/javascripts/alchemy/user_manual.js.coffee

@@ -0,0 +1,8 @@
+$ ->
+  # Because of the toolbar at the top, all anchor links scroll to their targets with an offset
+  $('.user_manual a[href^="#"]').on 'click', (e) ->
+    e.preventDefault()
+    $target = $("a[name=#{$(@).attr('href').split('#')[1]}]")
+    $("html, body").animate
+      scrollTop: $target.offset().top - '85'
+    , 200

data/app/assets/stylesheets/alchemy/user_manual.scss

@@ -0,0 +1,577 @@
+.alchemy_user_manual {
+  padding: 0 16px 16px;
+  line-height: 1.6;
+
+  a { text-decoration: underline }
+
+  h1,h2,h3,h4,h5,h6 {
+    margin: 20px 0 10px;
+    padding: 0;
+    font-weight: bold;
+    -webkit-font-smoothing: subpixel-antialiased;
+    cursor: text;
+  }
+
+  h1 {
+    font-size: 28px;
+    color: #000;
+  }
+
+  h2 {
+    font-size: 24px;
+    border-bottom: 1px solid #ccc;
+    color: #000;
+  }
+
+  h3 {
+    font-size: 18px;
+    color: #333;
+  }
+
+  h4 {
+    font-size: 16px;
+    color: #333;
+  }
+
+  h5 {
+    font-size: 14px;
+    color: #333;
+  }
+
+  h6 {
+    color: #777;
+    font-size: 14px;
+  }
+
+  p,blockquote,table,pre {
+    margin: 15px 0;
+  }
+
+  ul {
+    padding-left: 30px;
+  }
+
+  ol {
+    padding-left: 30px;
+  }
+
+  ol li ul:first-of-type {
+    margin-top: 0;
+  }
+
+  hr {
+    background: transparent url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAYAAAAECAYAAACtBE5DAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyJpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEzNDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNSBNYWNpbnRvc2giIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6OENDRjNBN0E2NTZBMTFFMEI3QjRBODM4NzJDMjlGNDgiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6OENDRjNBN0I2NTZBMTFFMEI3QjRBODM4NzJDMjlGNDgiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo4Q0NGM0E3ODY1NkExMUUwQjdCNEE4Mzg3MkMyOUY0OCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo4Q0NGM0E3OTY1NkExMUUwQjdCNEE4Mzg3MkMyOUY0OCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PqqezsUAAAAfSURBVHjaYmRABcYwBiM2QSA4y4hNEKYDQxAEAAIMAHNGAzhkPOlYAAAAAElFTkSuQmCC) repeat-x 0 0;
+    border: 0 none;
+    color: #ccc;
+    height: 4px;
+    padding: 0;
+  }
+
+  #wrapper>h2:first-child {
+    margin-top: 0;
+    padding-top: 0;
+  }
+
+  #wrapper>h1:first-child {
+    margin-top: 0;
+    padding-top: 0;
+  }
+
+  #wrapper>h1:first-child+h2 {
+    margin-top: 0;
+    padding-top: 0;
+  }
+
+  #wrapper>h3:first-child,#wrapper>h4:first-child,#wrapper>h5:first-child,#wrapper>h6:first-child {
+    margin-top: 0;
+    padding-top: 0;
+  }
+
+  a:first-child h1,a:first-child h2,a:first-child h3,a:first-child h4,a:first-child h5,a:first-child h6 {
+    margin-top: 0;
+    padding-top: 0;
+  }
+
+  h1+p,h2+p,h3+p,h4+p,h5+p,h6+p,ul li>:first-child,ol li>:first-child {
+    margin-top: 0;
+  }
+
+  dl {
+    padding: 0;
+  }
+
+  dl dt {
+    font-size: 14px;
+    font-weight: bold;
+    font-style: italic;
+    padding: 0;
+    margin: 15px 0 5px;
+  }
+
+  dl dt:first-child {
+    padding: 0;
+  }
+
+  dl dt>:first-child {
+    margin-top: 0;
+  }
+
+  dl dt>:last-child {
+    margin-bottom: 0;
+  }
+
+  dl dd {
+    margin: 0 0 15px;
+    padding: 0 15px;
+  }
+
+  dl dd>:first-child {
+    margin-top: 0;
+  }
+
+  dl dd>:last-child {
+    margin-bottom: 0;
+  }
+
+  blockquote {
+    border-left: 4px solid #DDD;
+    padding: 0 15px;
+    color: #777;
+  }
+
+  blockquote>:first-child {
+    margin-top: 0;
+  }
+
+  blockquote>:last-child {
+    margin-bottom: 0;
+  }
+
+  table {
+    border-collapse: collapse;
+    border-spacing: 0;
+    font-size: 100%;
+    font: inherit;
+  }
+
+  table th {
+    font-weight: bold;
+    border: 1px solid #ccc;
+    padding: 6px 13px;
+  }
+
+  table td {
+    border: 1px solid #ccc;
+    padding: 6px 13px;
+  }
+
+  table tr {
+    border-top: 1px solid #ccc;
+    background-color: #fff;
+  }
+
+  table tr:nth-child(2n) {
+    background-color: #f8f8f8;
+  }
+
+  img {
+    max-width: 100%;
+  }
+
+  code,tt {
+    margin: 0 2px;
+    padding: 0 5px;
+    white-space: nowrap;
+    border: 1px solid #eaeaea;
+    background-color: #f8f8f8;
+    border-radius: 3px;
+    font-family: Consolas,'Liberation Mono',Courier,monospace;
+    font-size: 12px;
+    color: #333;
+  }
+
+  pre>code {
+    margin: 0;
+    padding: 0;
+    white-space: pre;
+    border: 0;
+    background: transparent;
+  }
+
+  .highlight pre {
+    background-color: #f8f8f8;
+    border: 1px solid #ccc;
+    font-size: 13px;
+    line-height: 19px;
+    overflow: auto;
+    padding: 6px 10px;
+    border-radius: 3px;
+  }
+
+  pre {
+    background-color: #f8f8f8;
+    border: 1px solid #ccc;
+    font-size: 13px;
+    line-height: 19px;
+    overflow: auto;
+    padding: 6px 10px;
+    border-radius: 3px;
+  }
+
+  pre code,pre tt {
+    background-color: transparent;
+    border: 0;
+  }
+
+  .poetry pre {
+    font-family: Georgia,Garamond,serif!important;
+    font-style: italic;
+    font-size: 110%!important;
+    line-height: 1.6em;
+    display: block;
+    margin-left: 1em;
+  }
+
+  .poetry pre code {
+    font-family: Georgia,Garamond,serif!important;
+    word-break: break-all;
+    word-break: break-word;
+    -webkit-hyphens: auto;
+    -moz-hyphens: auto;
+    hyphens: auto;
+    white-space: pre-wrap;
+  }
+
+  sup,sub,a.footnote {
+    font-size: 1.4ex;
+    height: 0;
+    line-height: 1;
+    vertical-align: super;
+    position: relative;
+  }
+
+  sub {
+    vertical-align: sub;
+    top: -1px;
+  }
+
+  @media print {
+    body {
+        background: #fff;
+    }
+
+    img,pre,blockquote,table,figure {
+        page-break-inside: avoid;
+    }
+
+    #wrapper {
+        background: #fff;
+        border: 0;
+    }
+
+    code {
+        background-color: #fff;
+        color: #333!important;
+        padding: 0 .2em;
+        border: 1px solid #dedede;
+    }
+
+    pre {
+        background: #fff;
+    }
+
+    pre code {
+        background-color: white!important;
+        overflow: visible;
+    }
+  }
+
+  @media screen {
+    body.inverted {
+        color: #eee!important;
+        border-color: #555;
+        box-shadow: none;
+    }
+
+    .inverted #wrapper,.inverted hr .inverted p,.inverted td,.inverted li,.inverted h1,.inverted h2,.inverted h3,.inverted h4,.inverted h5,.inverted h6,.inverted th,.inverted .math,.inverted caption,.inverted dd,.inverted dt,.inverted blockquote {
+        color: #eee!important;
+        border-color: #555;
+        box-shadow: none;
+    }
+
+    .inverted td,.inverted th {
+        background: #333;
+    }
+
+    .inverted h2 {
+        border-color: #555;
+    }
+
+    .inverted hr {
+        border-color: #777;
+        border-width: 1px!important;
+    }
+
+    ::selection {
+        background: rgba(157,193,200,0.5);
+    }
+
+    h1::selection {
+        background-color: rgba(45,156,208,0.3);
+    }
+
+    h2::selection {
+        background-color: rgba(90,182,224,0.3);
+    }
+
+    h3::selection,h4::selection,h5::selection,h6::selection,li::selection,ol::selection {
+        background-color: rgba(133,201,232,0.3);
+    }
+
+    code::selection {
+        background-color: rgba(0,0,0,0.7);
+        color: #eee;
+    }
+
+    code span::selection {
+        background-color: rgba(0,0,0,0.7)!important;
+        color: #eee!important;
+    }
+
+    a::selection {
+        background-color: rgba(255,230,102,0.2);
+    }
+
+    .inverted a::selection {
+        background-color: rgba(255,230,102,0.6);
+    }
+
+    td::selection,th::selection,caption::selection {
+        background-color: rgba(180,237,95,0.5);
+    }
+
+    .inverted {
+        background: #0b2531;
+        background: #252a2a;
+    }
+
+    .inverted #wrapper {
+        background: #252a2a;
+    }
+
+    .inverted a {
+        color: #acd1d5;
+    }
+  }
+
+  .highlight .c {
+    color: #998;
+    font-style: italic;
+  }
+
+  .highlight .err {
+    color: #a61717;
+    background-color: #e3d2d2;
+  }
+
+  .highlight .k,.highlight .o {
+    font-weight: bold;
+  }
+
+  .highlight .cm {
+    color: #998;
+    font-style: italic;
+  }
+
+  .highlight .cp {
+    color: #999;
+    font-weight: bold;
+  }
+
+  .highlight .c1 {
+    color: #998;
+    font-style: italic;
+  }
+
+  .highlight .cs {
+    color: #999;
+    font-weight: bold;
+    font-style: italic;
+  }
+
+  .highlight .gd {
+    color: #000;
+    background-color: #fdd;
+  }
+
+  .highlight .gd .x {
+    color: #000;
+    background-color: #faa;
+  }
+
+  .highlight .ge {
+    font-style: italic;
+  }
+
+  .highlight .gr {
+    color: #a00;
+  }
+
+  .highlight .gh {
+    color: #999;
+  }
+
+  .highlight .gi {
+    color: #000;
+    background-color: #dfd;
+  }
+
+  .highlight .gi .x {
+    color: #000;
+    background-color: #afa;
+  }
+
+  .highlight .go {
+    color: #888;
+  }
+
+  .highlight .gp {
+    color: #555;
+  }
+
+  .highlight .gs {
+    font-weight: bold;
+  }
+
+  .highlight .gu {
+    color: #800080;
+    font-weight: bold;
+  }
+
+  .highlight .gt {
+    color: #a00;
+  }
+
+  .highlight .kc,.highlight .kd,.highlight .kn,.highlight .kp,.highlight .kr {
+    font-weight: bold;
+  }
+
+  .highlight .kt {
+    color: #458;
+    font-weight: bold;
+  }
+
+  .highlight .m {
+    color: #099;
+  }
+
+  .highlight .s {
+    color: #d14;
+  }
+
+  .highlight .na {
+    color: #008080;
+  }
+
+  .highlight .nb {
+    color: #0086b3;
+  }
+
+  .highlight .nc {
+    color: #458;
+    font-weight: bold;
+  }
+
+  .highlight .no {
+    color: #008080;
+  }
+
+  .highlight .ni {
+    color: #800080;
+  }
+
+  .highlight .ne,.highlight .nf {
+    color: #900;
+    font-weight: bold;
+  }
+
+  .highlight .nn {
+    color: #555;
+  }
+
+  .highlight .nt {
+    color: #000080;
+  }
+
+  .highlight .nv {
+    color: #008080;
+  }
+
+  .highlight .ow {
+    font-weight: bold;
+  }
+
+  .highlight .w {
+    color: #bbb;
+  }
+
+  .highlight .mf,.highlight .mh,.highlight .mi,.highlight .mo {
+    color: #099;
+  }
+
+  .highlight .sb,.highlight .sc,.highlight .sd,.highlight .s2,.highlight .se,.highlight .sh,.highlight .si,.highlight .sx {
+    color: #d14;
+  }
+
+  .highlight .sr {
+    color: #009926;
+  }
+
+  .highlight .s1 {
+    color: #d14;
+  }
+
+  .highlight .ss {
+    color: #990073;
+  }
+
+  .highlight .bp {
+    color: #999;
+  }
+
+  .highlight .vc,.highlight .vg,.highlight .vi {
+    color: #008080;
+  }
+
+  .highlight .il {
+    color: #099;
+  }
+
+  .highlight .gc {
+    color: #999;
+    background-color: #eaf2f5;
+  }
+
+  .type-csharp .highlight .k,.type-csharp .highlight .kt {
+    color: #00F;
+  }
+
+  .type-csharp .highlight .nf {
+    color: #000;
+    font-weight: normal;
+  }
+
+  .type-csharp .highlight .nc {
+    color: #2b91af;
+  }
+
+  .type-csharp .highlight .nn {
+    color: #000;
+  }
+
+  .type-csharp .highlight .s,.type-csharp .highlight .sc {
+    color: #a31515;
+  }
+
+
+}