origen_app_generators 0.0.3 → 0.1.0

data/templates/web/layouts/_basic.html.erb

@@ -1,18 +0,0 @@
----
-layout: bootstrap
-title: <%= options[:title] || Origen.app.namespace %>
----
-<%= render "templates/web/partials/navbar.html", tab: options[:tab] %>
-
-<div class="row">
-%# The markdown attribute is important if you are going to include content written
-%# in markdown, without this is will be included verbatim
-  <div class="span12" markdown="1">
-<%= yield %>    
-
-% if !options.has_key?(:yammer_comments) || options[:yammer_comments]
-<%= yammer_comments %>
-% end
-
-</div>
-</div>

data/templates/web/layouts/_doc.html.erb

@@ -1,37 +0,0 @@
----
-layout: bootstrap
-title: <%= options[:title] || "#{Origen.app.namespace} - Docs" %>
----
-<%= render "templates/web/partials/navbar.html", tab: :docs %>
-% s = {}
-
-%# This creates the index on the left of your doc pages
-%#
-%# Naming of the keys is very important and must be of the form:
-%#   <section>_<page> with no other underscores
-%# Origen will then look for the corresponding page in:
-%#   templates/web/docs/<section>/<page>.md.erb  
-%#  
-%# See here for more info: http://origen.freescale.net/doc_helpers/latest/examples/searchable/intro/
-
-% s["Environment"] = {
-%   environment_introduction: "Introduction",
-%   environment_installation: "Installation",
-% }
-% s["Developers"] = {
-%   developers_creating: "Creating a Generator",
-% }
-%
-%# Define additional sections as required, e.g.
-%# s["Registers"] = {
-%#   registers_map: "Register Map",
-%# }
-
-
-% render "doc_helpers/searchable.html", options.merge(:index => s) do
-
-<%= yield %>
-
-<%= yammer_comments %>
-
-% end

data/templates/web/origen_app_generators/application.md.erb

@@ -1,116 +0,0 @@
-% render "layouts/basic.html" do
-
-### OrigenAppGenerators
-
-## Generic Application
-
-Builds a generic Origen application shell that has no specific use case in mind.
-
-It will build the following application structure:
-
-~~~text
-|-- config
-|   |-- application.rb
-|   |-- commands.rb
-|   |-- environment.rb
-|   |-- users.rb
-|   |-- version.rb
-|-- doc
-|   |--history
-|-- lib
-|   |-- app_name
-|   |   |-- top_level.rb
-|   |-- app_name.rb
-|   |-- tasks
-|       |-- app_name.rake
-|-- spec
-|   |-- spec_helper.rb
-|-- log
-|-- output
-|-- targets
-|   |-- debug.rb
-|   |-- default.rb
-|   |-- production.rb
-|-- templates
-|    |-- web
-|-- Gemfile
-|-- Rakefile
-~~~
-
-**config**
-
-Holds all configuration information for your application
-
-**config/application.rb**
-
-This is the main configuration file where the behavior of Origen can be tailored
-to the needs of your application. The default settings are usually sufficient
-until your application becomes more advanced.
-
-**config/commands.rb**
-
-Custom origen commands can be added to your application, this is the preferred
-way of distributing any scripts required to support your application to your
-users. See the [command guide](http://origen.freescale.net/origen/latest/guides/custom/commands/)
-for details.
-
-**config/environment.rb**
-
-This file will be called by Origen to load your application environment, any files
-that you add to the lib directory should be loaded from here.
-
-**config/users.rb**
-
-Define your application users here, this is basically your mailing list for
-release notices.
-
-**config/version.rb**
-
-Defines the current application version. This file is managed by Origen via the
-'origen rc tag' command and should generally never be edited by hand.
-
-**doc**
-
-Any documentation related to your application can be stored here.
-
-**doc/history**
-
-A rolling log of your application tags and release notes is maintained here. A
-new entry is generated every time the 'origen rc tag' command is run. This file is
-pre-formatted to look good when rendered as a web page.
-
-**lib**
-
-All of your application models and logic should go in here. This folder is
-already added to Ruby's load path by Origen. Sub-folders can be used as desired
-to keep things organized. The contents of this folder will be accessible by
-any other applications which import this application.
-
-**log**
-
-All log output generated by Origen will be placed in here. There is a log containing
-the output from the last origen invocation and a rolling log from all previous
-runs.
-
-**output**
-
-By default all generated or compiled output will be placed in here.
-
-**target**
-
-A target defines which silicon design and/or test platform is being targeting
-by the generated content. All target definitions live in here.
-
-**templates**
-
-All templates used by the application should reside here, normally in sub-directories to separate
-them by type - e.g. templates/j750, templates/bench_code, templates/rtl, etc.
-
-**templates/web**
-
-Web based documentation of your project should reside here. Origen makes it easy
-to produce dynamic documentation based on your application target
-configurations. See http://origen.freescale.net for an example of the kind of
-documentation that can be produced.
-
-% end

data/templates/web/origen_app_generators/plugin.md.erb

@@ -1,29 +0,0 @@
-% render "layouts/basic.html" do
-
-### OrigenAppGenerators
-
-## Generic Plugin
-
-Builds a generic Origen plugin shell that has no specific use case in mind.
-
-The generated application is very similar to the [Generic Application](<%= path "origen_app_generators/application" %>),
-but with the following additional files:
-
-~~~text
-|-- config
-|   |-- development.rb
-|-- app_name.gemspec
-~~~
-
-Some file content may be slightly different to that for an application
-and it also has a different web doc structure to reflect the goal
-for all plugins to have consistent and snappy documentation.
-
-**config/development.rb**
-
-Similar to environment.rb this file can be used by plugins to require private
-files for the purposes of testing or for use in the development environment.
-Only files loaded by environment.rb will be available to applications importing
-the plugin.
-
-% end

data/templates/web/origen_app_generators/test_engineering/generic_test_block.md.erb

@@ -1,16 +0,0 @@
-% render "layouts/basic.html" do
-
-### OrigenAppGenerators
-
-## Generic Test Block
-
-This generates a customized version of the [Generic Plugin](<%= path "origen_app_generators/plugin" %>).
-
-At present this builds essentially the same as a generic plugin, but in future it will be
-enhanced with some domain specific configuration and added logic.
-
-Generally this is intended to be a shell for a test block that is an Origen plugin designed to
-work with a top-level BOM/product-specific application.
-
-% end
-

data/templates/web/partials/_navbar.html.erb

@@ -1,22 +0,0 @@
-<div class="navbar navbar-inverse navbar-fixed-top">
-  <div class="navbar-inner">
-    <div class="container">
-      <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-      </a>
-      <a class="brand" href="<%= path "/" %>">Home</a>
-      <div class="nav-collapse collapse">
-        <ul class="nav">
-          <li class="<%= options[:tab] == :docs ? 'active' : '' %>"><a href="<%= path("/docs/environment/introduction") %>">Docs</a></li>
-          <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
-          <li class="<%= options[:tab] == :archive ? 'active' : '' %>"><a href="<%= path "/archive" %>">Archive</a></li>
-          <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
-          <li class="<%= options[:tab] == :contact ? 'active' : '' %>"><a href="<%= path "/contact" %>">Contact</a></li>
-        </ul>
-        <%= import "origen/web/logo.html" %>
-      </div><!--/.nav-collapse -->
-    </div>
-  </div>
-</div>

data/templates/web/release_notes.md.erb

@@ -1,5 +0,0 @@
-% render "layouts/basic.html", tab: :release, yammer_comments: false do
-
-<%= render "#{Origen.root}/doc/history" %>
-
-% end