lato_core 1.1.5 → 2.1

data/app/views/lato_core/doc/doc/index.html.erb

@@ -0,0 +1,95 @@
+<%
+  row = cell(:elements, :row).new
+  block = cell(:elements, :block).new(class: 'xs-12 sm-12 md-12')
+%>
+
+<!-- PRESENTATION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'Lato Core Documentation') %>
+
+    <p>Lato is a modular software project.</p>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / PRESENTATION -->
+
+<!-- GENERAL SECTION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'General', size: 2) %>
+
+    <%=raw cell(:elements, :button).new(label: 'Installation', url: lato_core.doc_general_installation_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Personalization', url: lato_core.doc_general_personalization_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Languages', url: lato_core.doc_general_languages_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Generators', url: lato_core.doc_general_generators_path) %>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / GENERAL SECTION -->
+
+<!-- CELLS SECTION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'Cells', size: 2) %>
+
+    <p>Cells are object used to create the user interface.</p>
+
+    <%=raw cell(:elements, :title).new(label: 'Elements', size: 4) %>
+
+    <%=raw cell(:elements, :button).new(label: 'Row', url: lato_core.doc_cells_elements_row_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Block', url: lato_core.doc_cells_elements_block_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Button', url: lato_core.doc_cells_elements_button_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Buttongroup', url: lato_core.doc_cells_elements_buttongroup_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Flash', url: lato_core.doc_cells_elements_flash_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Icon', url: lato_core.doc_cells_elements_icon_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Title', url: lato_core.doc_cells_elements_title_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Table', url: lato_core.doc_cells_elements_table_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Table head', url: lato_core.doc_cells_elements_table_head_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Table body', url: lato_core.doc_cells_elements_table_body_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Table row', url: lato_core.doc_cells_elements_table_row_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Pagination', url: lato_core.doc_cells_elements_pagination_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Modal', url: lato_core.doc_cells_elements_modal_path) %>
+
+    <br><br>
+
+    <%=raw cell(:elements, :title).new(label: 'Inputs', size: 4) %>
+
+    <%=raw cell(:elements, :button).new(label: 'Form', url: lato_core.doc_cells_inputs_form_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Text', url: lato_core.doc_cells_inputs_text_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Number', url: lato_core.doc_cells_inputs_number_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Password', url: lato_core.doc_cells_inputs_password_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Email', url: lato_core.doc_cells_inputs_email_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Select', url: lato_core.doc_cells_inputs_select_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Textarea', url: lato_core.doc_cells_inputs_textarea_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Datetime', url: lato_core.doc_cells_inputs_datetime_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Checkbox', url: lato_core.doc_cells_inputs_checkbox_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Editor', url: lato_core.doc_cells_inputs_editor_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Dropzone', url: lato_core.doc_cells_inputs_dropzone_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Geolocalization', url: lato_core.doc_cells_inputs_geolocalization_path) %>
+    <%=raw cell(:elements, :button).new(label: 'Sortable Block', url: lato_core.doc_cells_inputs_sortableblock_path) %>
+
+    <br><br>
+
+    <%=raw cell(:elements, :title).new(label: 'Charts', size: 4) %>
+
+    <%=raw cell(:elements, :button).new(label: 'Bar vertical', url: lato_core.doc_cells_charts_bar_vertical_path) %>
+
+    <br><br>
+
+    <%=raw cell(:elements, :title).new(label: 'Widgets', size: 4) %>
+
+    <%=raw cell(:elements, :button).new(label: 'Index', url: lato_core.doc_cells_widgets_index_path) %>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / CELLS SECTION -->

data/app/views/lato_core/doc/general/generators.html.erb

@@ -0,0 +1,60 @@
+<%
+  row = cell(:elements, :row).new
+  block = cell(:elements, :block).new(class: 'xs-12 sm-12 md-12')
+  code = cell(:elements, :code).new
+%>
+
+<!-- PRESENTATION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'General: Generators') %>
+
+    <p>Generators are used to speed up your development with lato.</p>
+
+    <p>To initialize your project with lato you can run:</p>
+
+<%=raw code.open %>
+
+$> rails generate lato_core:initializer
+
+<%=raw code.close %>
+
+    <p>
+    This command should:
+      <ul>
+        <li>Create a application_controller.rb file inside app/controllers/lato path.</li>
+        <li>Create a index.html.erb file inside app/views/lato/application path.</li>
+        <li>Create some stylesheets files inside app/assets/stylesheets/lato path.</li>
+        <li>Create a application.js file inside app/assets/javascripts/lato path.</li>
+        <li>Create a logo.svg file inside app/assets/images/lato path.</li>
+      </ul>
+    </p>
+
+    <br>
+
+    <p>To generate files used to manage a crud you can run:</p>
+
+<%=raw code.open %>
+
+$> rails generate lato_core:crud
+
+<%=raw code.close %>
+
+    <p>
+      This command should:
+      <ul>
+        <li>Create a crud_controller.rb file inside app/controllers/lato path.</li>
+        <li>Create a index.html.erb file inside app/views/lato/crud path.</li>
+        <li>Create a show.html.erb file inside app/views/lato/crud path.</li>
+        <li>Create a new.html.erb file inside app/views/lato/crud path.</li>
+        <li>Create a edit.html.erb file inside app/views/lato/crud path.</li>
+        <li>Create a _form.html.erb file inside app/views/lato/crud/shared path.</li>
+      </ul>
+    </p>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / PRESENTATION -->

data/app/views/lato_core/doc/general/installation.html.erb

@@ -0,0 +1,49 @@
+<%
+  row = cell(:elements, :row).new
+  block = cell(:elements, :block).new(class: 'xs-12 sm-12 md-12')
+  code = cell(:elements, :code).new
+%>
+
+<!-- PRESENTATION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'General: Installation') %>
+
+    <p>Install Lato Core is simple. First of all you need to add the gem on your gemfile:</p>
+
+<%=raw code.open %>
+
+gem 'lato_core', git: 'https://github.com/ideonetwork/lato-core'
+
+<%=raw code.close %>
+
+    <p>Install the gem with bundle:</p>
+
+<%=raw code.open %>
+
+$> bundle install
+
+<%=raw code.close %>
+
+    <p>Copy the Lato Core migrations on your application:</p>
+
+<%=raw code.open %>
+
+$> rails lato_core:install:migrations
+
+<%=raw code.close %>
+
+    <p>Run the migrations:</p>
+
+<%=raw code.open %>
+
+$> bundle exec rake db:migrate
+
+<%=raw code.close %>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / PRESENTATION -->

data/app/views/lato_core/doc/general/languages.html.erb

@@ -0,0 +1,67 @@
+<%
+  row = cell(:elements, :row).new
+  block = cell(:elements, :block).new(class: 'xs-12 sm-12 md-12')
+  code = cell(:elements, :code).new
+%>
+
+<!-- PRESENTATION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'General: Languages') %>
+
+    <p>
+    Every Lato module can contains its own language translations. Its translations can be personalized for the main application.
+    The first thing to do to personalize a module translations is to copy translactions files on your application:
+    </p>
+
+<%=raw code.open %>
+
+$> rails lato:load_languages
+
+<%=raw code.close %>
+
+  <p>
+  An example of translactions file should be:
+  </p>
+
+<%=raw code.open %>
+
+menu:
+  dashboard: Dashboard
+  superusers: Superusers
+  superusers_new: Add new
+  superusers_index: Show all
+  documentation: Doc. Core
+
+forms:
+  username: Username
+  password: Password
+  name: Name
+  surname: Surname
+  email: Email
+  password_confirmation: Confirm password
+  username_help: Username should have minimum 4 characters
+  password_help: Paasword should have minimum 6 characters
+  password_confirmation_help: We ask you to repeat the password to be sure that you know it
+  permission: Permission
+  id: Id
+  biography: Write something about you
+  last_login_ip_address: Last login IP address
+  last_login_datetime: Last login datetime
+
+flashes:
+  user_not_found: User not found
+  uncorrect_password: Password is not correct
+  logout_success: User correctly logged out
+  superuser_create_success: The Superuser was created successfully
+  superuser_not_found: The Superuser you search is not present on the system
+  superuser_not_permission: You don't have permission to do this action
+  superuser_update_success: The Superuser was updated successfully
+  superuser_destroy_success: The Superuser was destroied successfully
+
+<%=raw code.close %>
+
+<%=raw row.close %>
+<!-- / PRESENTATION -->

data/app/views/lato_core/doc/general/personalization.html.erb

@@ -0,0 +1,177 @@
+<%
+  row = cell(:elements, :row).new
+  block = cell(:elements, :block).new(class: 'xs-12 sm-12 md-12')
+  code = cell(:elements, :code).new
+%>
+
+<!-- PRESENTATION -->
+<%=raw row.open %>
+
+  <%=raw block.open %>
+
+    <%=raw cell(:elements, :title).new(label: 'General: Personalization') %>
+
+    <p>
+    Every Lato module can be customized. The first thing to do to personalize a module is
+    to copy configurations files on your application:
+    </p>
+
+<%=raw code.open %>
+
+$> rails lato:load_configs
+
+<%=raw code.close %>
+
+  <p>
+  With this command you can find a list of files inside the <i>/config/lato</i> directory for every lato
+  module you are using on the application.
+  </p>
+
+  <p>
+  There is a list of configurations used on every module.
+  </p>
+
+  <br>
+  <%=raw cell(:elements, :title).new(label: 'Menu', size: 4) %>
+
+  <p>
+  The menu config is used to define the list of voices on the sidebar.
+  </p>
+
+  <p>
+  Every menu voice should have an icon, a title, a relative url, a position value, the minimum and
+  maximum level of user permissions to be showed.
+  </p>
+
+<%=raw code.open %>
+
+menu:
+  core_dashboard:
+    icon: tachometer
+    title: Dashboard
+    url: /lato/core/dashboard
+    position: 1
+    permission_min: 0
+    permission_max: 99
+
+<%=raw code.close %>
+
+  <p>
+  There is another optional option called "sub_items" for a menu voice used to set sub voices.
+  Every sub item should have a title, a relative url, the minimum and maximum level of user permissions to be showed.
+  </p>
+
+<%=raw code.open %>
+
+menu:
+  core_dashboard:
+    icon: tachometer
+    title: Dashboard
+    url: /lato/core/dashboard
+    position: 1
+    permission_min: 0
+    permission_max: 99
+    sub_items:
+      stat:
+        title: Stat
+        url: /lato/core/stat
+        permission_min: 0
+        permission_max: 99
+      other:
+        title: Other
+        url: /lato/core/other
+        permission_min: 0
+        permission_max: 99
+        
+<%=raw code.close %>
+
+  <p>
+  Sometimes you need to translate the title of a menu voice. You can set on the language file a list
+  of translations called "menu" and take one of its values on the menu configuration with a special title "translate[translation_key]".
+  </p>
+
+<%=raw code.open %>
+
+# configs yaml file
+
+menu:
+  core_dashboard:
+    icon: tachometer
+    title: translate[dashboard]
+    url: /lato/core/dashboard
+    position: 1
+    permission_min: 0
+    permission_max: 99
+
+# language yaml file
+
+menu:
+  dashboard: Dashboard
+
+<%=raw code.close %>
+
+  <br>
+  <%=raw cell(:elements, :title).new(label: 'Assets', size: 4) %>
+
+  <p>
+  The assets config is used to define the list of assets that the application should import on the main layout.
+  </p>
+
+  <p>
+  To add an assets file on the main layout you need to follow these instructions:
+  <ul>
+    <li>Require your assets on the file config/initializers/assets.rb</li>
+    <li>Add the assets on the configuration file.</li>
+  </ul>
+  </p>
+
+<%=raw code.open %>
+
+assets:
+  core_style:
+    path: lato_core/application # path of assets file
+    type: stylesheet # type of file (stylesheet / javascript)
+
+<%=raw code.close %>
+
+  <br>
+  <%=raw cell(:elements, :title).new(label: 'Widgets', size: 4) %>
+
+  <p>
+  A widget is an element on the header that can be used to open a small popup with a content.
+  To add a new widget on the header you can set a widget object with an icon, the path of the code for the popup,
+  the position and the title.
+  </p>
+
+<%=raw code.open %>
+
+widgets:
+  core_system_info:
+    icon: info
+    path: lato_core/widgets/systeminfo # path of widget partial
+    position: 1
+    title: Info
+
+<%=raw code.close %>
+
+  <br>
+  <%=raw cell(:elements, :title).new(label: 'Partials', size: 4) %>
+
+  <p>
+  A partial is a part of code that can be added to every page.
+  To Add a new partial you can set the partials list.
+  </p>
+
+<%=raw code.open %>
+
+partials:
+  core_gmaps:
+    path: lato_core/partials/gmaps
+    position: 2
+
+<%=raw code.close %>
+
+  <%=raw block.close %>
+
+<%=raw row.close %>
+<!-- / PRESENTATION -->