RubyGems - alchemy-demo_kit - Versions diffs - 0.0.1 - Mend

alchemy-demo_kit 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

data/app/views/alchemy/page_layouts/_standard.html.erb ADDED

@@ -0,0 +1,14 @@
+<div id="header">
+  <div id="header_image">
+    <%= render_elements(:only => 'header', :fallback => {:for => 'header', :from => 'layout_header'}) %>
+  </div>
+  <%- claim = render_elements :only => ["claim"] -%>
+  <%- if !claim.blank? -%>
+  <div id="claim">
+    <%= claim %>
+  </div>
+  <%- end -%>
+</div>
+<div id="content">
+  <%= render_elements :except => ["claim", "header"] %>
+</div>

data/app/views/layouts/application.html.erb ADDED

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- Your site title-prefix (That is YourSite in "YourSite - CurrentPage" is taken from a layout-page by default.
+      Alternatively you can hardcode it here -->
+    <%= render_meta_data(:title_prefix => sitename_from_header_page, :title_seperator => " - ") %>
+    <!-- Paths here are relative to app/assets/stylesheets.
+      alchemy/demo_kit, though, is located in the Alchemy demo kit gem and doesn't have to be present in your app,
+       but you can copy it over and customize it of course. -->
+    <%= stylesheet_link_tag "alchemy/demo_kit", :media => :screen %>
+    <%= stylesheet_link_tag "alchemy/demo_kit", :media => :print %>
+    <!-- Here is also the place for custom javascripts. Put them in app/assets/javascripts/yourscript.js (or yourscript.js.coffee)
+      and include them like this (remove the \):
+    <\%= javascript_include_tag "yourscript" %> -->
+  </head>
+  <body>
+    <div id="page">
+      <div id="language_select">
+        <!-- Render links with flags for all public languages -->
+        <%= language_switches(:linkname => :code) %>
+      </div>
+      <div id="breadcrump">
+        <!-- Renders a breadcrumb/ariadne-path. For customizing see docs for render_breadcrumb (link?) -->
+        <%= render_breadcrumb :seperator => "<span>&nbsp;<&nbsp;</span>" %>
+      </div>
+      <div id="navigation">
+        <!-- Renders main navigation. For customizing see docs for render_navigation (link?)
+            You can overwrite app/views/navigation/_renderer.html.erb and app/views/navigation/_link.html.erb
+            if you want to roll out your own markup -->
+        <%= render_navigation :all_sub_menues => true %>
+      </div>
+      <!-- Most important call here!
+        This yields (=inserts) all content of the current page.
+        Markup depends on page_layout, elements and essences and can be changed in app/views/alchemy/... -->
+      <%= yield %>
+      <div class="footer">
+        <!-- Renders elements that are called "footnote" (name-attribute in elements.yml)
+          from page_layout "layout_footer" (name-attribute in page_layout.yml) -->
+        <%= render_elements(
+          :from_page => 'layout_footer',
+          :only => ['footnote']
+        ) %>
+      </div>
+    </div>
+    <!-- This is used in Alchemy's backend to prevent navigating to other pages through the preview window -->
+    <%= alchemy_preview_mode_code %>
+    <!-- Renders a menu_bar when a user with sufficient rights visits a page -->
+    <%= alchemy_menu_bar %>
+  </body>
+</html>

data/config/alchemy/elements.yml ADDED

@@ -0,0 +1,274 @@
+# == In this configuration you setup Alchemy´s element layouts.
+#
+# Use rails generate alchemy:scaffold to generate this file for your app.
+#
+# Elements containing all necessary basic tools for displaying and editing content inside Alchemy.
+# They consists of composed contents (different essence-types) as shown in the illustration of an elements-sheme below.
+#
+# == Schema of an element
+#
+#   =================================
+#   #  Content 1 (EssenceText)      #
+#   #                               #
+#   #  Content 2 (EssencePicture)   #
+#   #                               #
+#   #  Content 3 (EssenceRichtext)  #
+#   =================================
+#
+# == Example of a basic element layout
+#
+#   - name: a_unique_name (Used for the partial name in +app/views/elements+ and translated as Element.display_name)
+#     unique: Bool //pass true if this element only can be displayed once on page
+#     contents:
+#     - name: head
+#       type: EssenceText
+#     - name: text
+#       type: EssenceRichtext
+#
+# As already mentioned above, there are different content-types wich can be defined for each content in an element.
+#
+# Defining these types is used to render predefined views in the element.
+#
+# == Content-Types:
+#
+# * EssenceText               (Used to store a String (max. 255 Chars.) i.e. a headline, or productname. The editor is renderd as a single-lined input field. The view output will be sanitized and escaped. So it's XSS save.)
+# * EssenceRichtext           (Used to store editable richtext. Editor is rendered as a textarea with TinyMCE Editor.)
+# * EssencePicture            (Used to store pictures assigned through the library. The editor view provides a lot of options (i.e. image cropper). The view renders the assigned picture, resizes it, crops it and caches the result.)
+# * EssenceFile               (Used to store attachments assigned through the library. The view renders download link.)
+# * EssenceAudio              (Used to store attachments assigned through the library. The view renders an flash audio player.)
+# * EssenceVideo              (Used to store attachments assigned through the library. The view renders an flash video player.)
+# * EssenceFlash              (Used to store attachments assigned through the library. The view renders the embeded flash object.)
+# * EssenceDate               (Used to store a DateTime object. The view output is passed through Rails I18n Library, so it will be fully localized.)
+# * EssenceHtml               (Used to store HTML code. The view output renders the raw, not sanitized or unescaped String. So be careful!)
+# * EssenceSelect             (Used to store a String (max. 255 Chars.) value. The editor view is displayed as a select box)
+# * EssenceBoolean            (Used to store a Boolean (true or false) value. The editor view is displayed as a check box)
+# * EssenceLink               (Used to store an URL. The link button opens the same link overlay as the link button in the EssenceRichtext TinyMCE editor.)
+#
+# After finishing the setup of your element layouts, you need to generate the files for the elements before using them in Alchemy.
+#
+# For creating these files, use the following command in your terminal:
+#
+#   rails g alchemy:elements
+#
+# or:
+#
+#   rails g alchemy:elements --skip
+#
+# to skip existing elements
+#
+#
+# All new elements will be created as two different partials in +Rails.root/app/views/elements+.
+#
+# For each element there is an editor-view wich will be rendered when editing them in Alchemy and another view for the website´s frontend.
+#
+#   app/views/elements/_elements_name_editor.html.erb
+#   app/views/elements/_elements_name_view.html.erb
+#
+# For most contents in an element you can specify additional options, so they get rendered in a specific way.
+# These options can be defined as symbols, but its too much to list them up here.
+# You can find these options described in the application_helper.rb, most of them at the render_essence method.
+#
+# == Setting a content as preview-text for the element
+#
+# You can set a content-essence as preview-text for its element like this:
+#
+#   take_me_for_preview: true
+#
+# == Adding contents dynamically in the frontend
+#
+# You are able to add content-essences dynamically to the element from the Alchemy frontend.
+#
+# You just have to make contents available for adding them.
+#
+# === Example:
+#
+#   - name: headline
+#     unique: false
+#     contents:
+#     - name: headline
+#       type: EssenceText
+#     - name: big_text
+#       type: EssenceRichtext
+#     available_contents:
+#     - name: big_text
+#       type: EssenceRichtext
+#
+# And add a +<%= render_create_content_link(element, 'big_text') %>+ helper to your element editor partial.
+#
+# Now an Alchemy user can add as many additional +big_text+ contents as s/he wants.
+#
+# If you have more then one additional content defined you should use the:
+#
+#   <%= render_new_content_link(element) %>
+#
+# helper. This opens an overlay from where the user can choose which content to add.
+#
+# === Translate element names
+#
+# Element names are passed through the +I18n+ library. So you can translate them in your config/locales language yml file.
+#
+# === Example:
+#
+#   de:
+#     alchemy:
+#       element_names:
+#         contact: Kontakt
+#         search: Suche
+#
+# == Validations:
+#
+#   You can validate the presence of a content. Just pass validate and one of the supported vaidatiosn methods to your content definition:
+#
+#     - name: article
+#       display_name: Standard-Artikel
+#       contents:
+#       - name: intro
+#         type: EssenceText
+#         validate:
+#           - presence
+#
+# Now the user has to enter a value inside of the intro EssenceText textfield to save the element.
+# Currently supported validations are:
+#
+#    * presence
+#    * uniqueness
+#
+- name: article
+  taggable: true
+  contents:
+  - name: intro
+    type: EssenceText
+  - name: headline
+    type: EssenceText
+    settings:
+      deletable: true
+  - name: image
+    type: EssencePicture
+  - name: text
+    type: EssenceRichtext
+    settings:
+      deletable: true
+  available_contents:
+  - name: text
+    type: EssenceRichtext
+  - name: headline
+    type: EssenceText
+- name: intro_image_text
+  unique: true
+  contents:
+  - name: headline
+    type: EssenceText
+  - name: image
+    type: EssencePicture
+  - name: text
+    type: EssenceRichtext
+- name: text
+  contents:
+  - name: text
+    type: EssenceRichtext
+- name: bild
+  contents:
+  - name: image
+    type: EssencePicture
+- name: bild_text
+  contents:
+  - name: image
+    type: EssencePicture
+  - name: text
+    type: EssenceRichtext
+- name: headline
+  contents:
+  - name: headline
+    type: EssenceText
+- name: image_mosaic
+  picture_gallery: true
+  contents:
+  - name: caption
+    type: EssenceText
+  - name: show_caption
+    type: EssenceBoolean
+- name: footnote
+  unique: true
+  contents:
+  - name: note
+    type: EssenceRichtext
+- name: sitename
+  unique: true
+  contents:
+  - name: name
+    type: EssenceText
+- name: claim
+  unique: true
+  contents:
+  - name: claim
+    type: EssenceText
+- name: header
+  unique: true
+  contents:
+  - name: image
+    type: EssencePicture
+- name: intro
+  contents:
+  - name: intro
+    type: EssenceRichtext
+- name: subheadline
+  contents:
+  - name: subheadline
+    type: EssenceText
+- name: download
+  contents:
+  - name: file
+    type: EssenceFile
+    settings:
+      deletable: true
+  available_contents:
+  - name: file
+    type: EssenceFile
+- name: news
+  contents:
+  - name: date
+    type: EssenceDate
+  - name: news_headline
+    type: EssenceText
+    rss_title: true
+  - name: body
+    type: EssenceRichtext
+    rss_description: true
+- name: searchresult
+  unique: true
+- name: contactform
+  unique: true
+  contents:
+  - name: mail_from
+    type: EssenceText
+    validate:
+      - presence
+  - name: mail_to
+    type: EssenceText
+    validate:
+      - presence
+  - name: subject
+    type: EssenceText
+    take_me_for_preview: true
+    validate:
+      - presence
+  - name: success_page
+    type: EssenceSelect
+    validate:
+      - presence

data/config/alchemy/page_layouts.yml ADDED

@@ -0,0 +1,74 @@
+# == This file defines the page_layouts for new pages.
+#
+# Please make your own page_layouts for your app in your own Rails.root/config/alchemy/page_layouts.yml file.
+#
+# === DSL:
+#   - name: String                  # The name of the layout used for views and inside the database. You can render a layout with the render_page_layout(name) helper.
+#     unique: Bool                  # Pass true and the user can only choose this layout once inside a language tree.
+#     hide: Bool                    # Pass true to hide this layout from the user.
+#     elements: Array               # A list of element names that can be placed on this layout i.e. [text, picture]. Elements are defined inside the elements.yml file.
+#     insert_elements_at: String    # Pass top to insert elements at top of the list. Default: bottom
+#     autogenerate: Array           # A list of element names that are autogenerated after creating the Page.
+#     searchresults: Bool           # Pass true to enable rendering the searchresults of the fulltext-search.
+#     layoutpage: Bool              # Layoutpages are outside the normal pagetree and can be used to place "global" language independent Elements.
+#     cache: Bool                   # Pass false to disable the caching for this pages.
+#     feed: Bool                    # Pass true to enable a RSS feed of news elements from this page.
+#     redirects_to_external: Bool   # Pass true to disable normal page rendering and redirect to a external page instead.
+#     controller: controller_name   # Controller to use instead of the default PagesController
+#     action: action_name           # Controllers action to use instead of the default PagesController#show
+#
+# === Translate page layout names
+#
+# Page layout names are passed through the I18n library. So you can translate them in your config/locales language yml file.
+#
+# Example:
+#
+#   de:
+#     alchemy:
+#       page_layout_names:
+#         contact: Kontakt
+#         search: Suche
+#
+- name: intro
+  unique: true
+  elements: [header, intro_image_text]
+  autogenerate: [header, intro_image_text]
+- name: standard
+  elements: [article, claim, header, bild, bild_text, text, intro, headline, image_mosaic, download]
+  autogenerate: [header, claim, article]
+  taggable: true
+- name: contact
+  unique: true
+  cache: false
+  elements: [headline, text, contactform]
+  autogenerate: [headline, text, contactform]
+- name: news
+  feed: true
+  unique: true
+  insert_elements_at: top
+  elements: [headline, news]
+  autogenerate: [news]
+  feed_elements: [news]
+- name: search
+  unique: true
+  elements: [headline, text, searchresult]
+  autogenerate: [searchresult]
+  searchresults: true
+- name: layout_header
+  unique: true
+  layoutpage: true
+  taggable: true
+  elements: [sitename, header]
+- name: layout_footer
+  unique: true
+  layoutpage: true
+  elements: [footnote]
+- name: external
+  redirects_to_external: true

data/lib/alchemy/demo_kit.rb ADDED

@@ -0,0 +1,6 @@
+require 'alchemy/demo_kit/engine'
+module Alchemy
+  module DemoKit
+  end
+end

data/lib/alchemy/demo_kit/engine.rb ADDED

@@ -0,0 +1,6 @@
+module Alchemy
+  module DemoKit
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/alchemy/demo_kit/version.rb ADDED

@@ -0,0 +1,5 @@
+module Alchemy
+  module DemoKit
+    VERSION = "0.0.1"
+  end
+end

data/lib/rails/generators/alchemy/demo_kit_generator.rb ADDED

@@ -0,0 +1,34 @@
+require 'rails'
+module Alchemy
+  module Generators
+    class DemoKitGenerator < ::Rails::Generators::Base
+      desc "This generator installs the Alchemy demo kit."
+      source_root File.expand_path('../../../../app/views', File.dirname(__FILE__))
+      def alchemy_scafffold
+        invoke "alchemy:scaffold"
+      end
+      def copy_files
+        copy_file "#{config_path}/elements.yml", "#{Rails.root}/config/alchemy/elements.yml"
+        copy_file "#{config_path}/page_layouts.yml", "#{Rails.root}/config/alchemy/page_layouts.yml"
+        copy_file "layouts/application.html.erb", "#{Rails.root}/app/views/layouts/application.html.erb"
+        directory "alchemy/elements", "#{Rails.root}/app/views/alchemy/elements/"
+        directory "alchemy/page_layouts", "#{Rails.root}/app/views/alchemy/page_layouts/"
+      end
+      def inject_css_into_env
+        sentinel = /::Application\.configure do\s*$/
+        inject_into_file "#{Rails.root}/config/environments/production.rb", "\n  config.assets.precompile += %w( alchemy/demo_kit.css )\n", { :after => sentinel, :verbose => true }
+      end
+    private
+      def config_path
+        @config_path ||= File.expand_path('../../../../config/alchemy', File.dirname(__FILE__))
+      end
+    end
+  end
+end