drg_manual 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b36a79e8dbe75bfafaf0b8642614779135c72b
-  data.tar.gz: 3d42fbbe16e52f0d98fb6d8860e7d40d96a167af
+  metadata.gz: c0eb5487551076bd4b456c53d17eb011bc5f5892
+  data.tar.gz: d59223949730f3a49bb0122a86d9d99dc29cc963
 SHA512:
-  metadata.gz: 3e34cf27842f0a14e3a79d6241e2ad7bb7d2d64afa22234213bad858316d67e9522c288584ffaee463eedbecd741766e44a4a6261be68e3365fddce7c706692b
-  data.tar.gz: 12fc6a4239183c20caf54c63cf17139d5e4a6ff6c7c3bd9b825ac3f46f2433f88963c5642c562b9a6ff78c5d64e079b3c7a9c6b885382dfc6c1f144ce63b3275
+  metadata.gz: 1bf0504aaea30375fddfc971c3c1c89637ec796911738d5dc908ec922e8957d8fc193ad3bf9fb53b68526443ec684b93acc46a4bb83961277dce395cd8ce6299
+  data.tar.gz: ec02129fe0f099f0fab2652a5594ee7e71edf8c4b8b2db35460634c1c8afd61aa2af6e82f3a0f3b96f487e478fc7c9e4d7f9340836365544f29bbe988f832fdc

data/README.md

@@ -1,60 +1,30 @@
-# DrgBooks
+# DrgManual
 
-DrgBooks plugin implements documentation management in DRG CMS enabled web site.
+DrgManual implements documentation manual web element for DRG CMS.
 
-Configuration
-----------------
-
-Usage:
+##Usage:
 
 Add this line to your Gemfile:
-```ruby
-  gem 'drg_books'
-```  
-
-Create apropriate dc_page document with related design. Use this line in design.
-```irb
-div id="docs"><%= dc_render(:dc_book) %></div>
-```
 
-Update routes.rb
 ```ruby
-  get '/books/:method/:book_id/', to: 'dc_main#page', :defaults => { path: 'books' }
-  get '/books/:method/:book_id/:chapter_id', to: 'dc_main#page', :defaults => { path: 'books' }
-  get '/books/:method/:book_id/:chapter_id/:version', to: 'dc_main#page', :defaults => { path: 'books' }
+gem 'drg_manual'
 ```
+Create new Design document and put this line of code into it.
 
-Documentation
--------------
-
-Please see the DRG CMS website for up-to-date documentation:
-[www.drgcms.org](http://www.drgcms.org)
-
-License
--------
-
-Copyright (c) 2012-2015 Damjan Rems
+```irb
+<%= dc_render :dc_manual %>
+```
+then create new Page document and link it to design.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+You may wrap code with div element.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```irb
+<%= dc_render(:dc_manual, div: 'wrap-class my-manual-class') %>
+```
 
-Credits
--------
+## Contributing
+Fork this repository on GitHub and issue a pull request
 
-Damjan Rems: damjan dot rems at gmail dot com
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/models/dc_manual.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2018 Damjan Rems
+# Copyright (c) 2018+ Damjan Rems
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,7 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-
+##########################################################################
+# DcManual model definition. DcManual defines common data for manual document.
+##########################################################################
 class DcManual
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -108,15 +110,7 @@ def self.update_menu(document)
 end
 
 ######################################################################
-# Meni za vse
-######################################################################
-#def self.all_manuals_menu()
-#  manuals = self.only(:id, :title, :link).where(active: true).order_by(title: 1).to_a
-#  manuals.inject([]) { |result, manual| result += self.meni_en_prirocnik(element) }
-#end
-
-######################################################################
-# Returns menu for manual
+# Returns menu for single manual
 ######################################################################
 def self.get_menu(manual)
   manual.menu.split("\n").each.inject([]) do |result, line|
@@ -125,7 +119,7 @@ def self.get_menu(manual)
 end
 
 ######################################################################
-# Vrne menije za vse priročnike
+# Returns menu for all manuals
 ######################################################################
 def self.get_all_menus()
   manuals = self.only(:menu).where(active: true).order_by(title: 1).to_a

data/app/models/dc_manual_page.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2018 Damjan Rems
+# Copyright (c) 2018+ Damjan Rems
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,6 +21,11 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+##########################################################################
+# DcManualPage model definition. 
+# 
+# DcManualPage defines data for single page on manual document.
+##########################################################################
 class DcManualPage
   include Mongoid::Document
   include Mongoid::Timestamps

data/lib/drg_manual/version.rb

@@ -1,3 +1,3 @@
 module DrgManual
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drg_manual
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Damjan Rems
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drg_cms
@@ -35,7 +35,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/stylesheets/drg_manual.css
-- app/controllers/drgcms_controls/dc_book_chapter_dc_reply_control.rb
 - app/forms/cms_menu.yml
 - app/forms/dc_manual.yml
 - app/forms/dc_manual_page.yml
@@ -43,10 +42,7 @@ files:
 - app/helpers/dc_manual_renderer.rb
 - app/models/dc_manual.rb
 - app/models/dc_manual_page.rb
-- app/views/dc_manual/_chapter.html.erb
-- app/views/dc_manual/_chapter_old.html.erb
 - app/views/dc_manual/_list.html.erb
-- app/views/dc_manual/_toc.html.erb
 - config/locales/dc_manual_en.yml
 - config/locales/dc_manual_sl.yml
 - config/routes.rb

data/app/controllers/drgcms_controls/dc_book_chapter_dc_reply_control.rb

@@ -1,50 +0,0 @@
-#encoding: utf-8
-#--
-# Copyright (c) 2014+ Damjan Rems
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-######################################################################
-# DrgcmsControls for DcBlog.DcReply form
-######################################################################
-module DrgcmsControls::DcBookChapterDcReplyControl
-
-######################################################################
-# Called when new empty record is created
-######################################################################
-def dc_new_record()
-# fill with quote when reply_to is present  
-  if params[:reply_to]
-    replyto = @record._parent.dc_replies.find(params[:reply_to])
-    @record.subject = "Re: #{replyto.subject}"
-    @record.body = "<div class='dc-forum-quote'>#{replyto.body}</div><br>"
-  end
-  @record.created_by_name = session[:user_name] if session[:user_name]
-end
-
-######################################################################
-# Called before save. Reloads browser.
-######################################################################
-def dc_before_save()
-  params[:return_to] = 'parent.reload'
-end
-
-end 

data/app/views/dc_manual/_chapter.html.erb

@@ -1,36 +0,0 @@
-<div class="book-top"><%= chapter.dc_book.title %></div>
-
-<div class="book-chapter-title"><%= chapter.title %></div>
-<div class="book-chapter-prev-next">
-  <%= dc_link_to(prev_chapter.title, 'hand-o-left', controller: :books, method: 'chapter', 
-              book_id: prev_chapter.dc_book.link, chapter_id: prev_chapter.link ) if prev_chapter %>&nbsp;|&nbsp;
-  <%= dc_link_to(' ','hand-o-up', book_id: chapter.dc_book.link, method: 'toc' ) %>&nbsp;|&nbsp;
-  <%= dc_link_to(next_chapter.title, 'hand-o-right', controller: :books, method: 'chapter', 
-              book_id: next_chapter.dc_book.link, chapter_id: next_chapter.link ) if next_chapter %>
-</div>
-
-<div class="book-chapter-text">
-  <%= if dc_edit_mode?
-    dc_link_for_edit({ controller: 'cmsedit', action: 'edit', id: text._id, ids: chapter._id, 
-        table: 'dc_book_chapter;dc_book_text', title: "#{t('drgcms.edit')}" })
-    end %>
-
-  <%= text.body.html_safe %>
-</div>
-
-<div class="book-chapter-prev-next">
-  <%= dc_link_to(prev_chapter.title, 'hand-o-left', method: 'chapter', 
-              book_id: prev_chapter.dc_book.link, chapter_id: prev_chapter.link ) if prev_chapter %>&nbsp;|&nbsp;
-  <%= dc_link_to(' ','hand-o-up', book_id: chapter.dc_book.link, method: 'toc' ) %>&nbsp;|&nbsp;
-  <%= dc_link_to(next_chapter.title, 'hand-o-right', method: 'chapter', 
-              book_id: next_chapter.dc_book.link, chapter_id: next_chapter.link ) if next_chapter %>
-</div>
-
-<div class="book-replies">
-  <h2><%= t('dc_blog.comments') %></h2>
-  <%= render partial: 'dc_replay/reply', formats: [:html], 
-             locals: { replies: replies, parent_doc: chapter, parent_document: 'dc_book_chapter' } %>
-</div>
-<br>
-
-<iframe id="iframe_edit" name="iframe_edit" scrolling="no"></iframe>

data/app/views/dc_manual/_chapter_old.html.erb

@@ -1,34 +0,0 @@
-<div class="book-top">
-  <%= chapter.dc_book.title %>
-  <div style="font-size:0.6em;"><%= chapter.title %></div>
-</div>
-<div class="book-chapter-versions"><%= t('drgcms.version', 'Version') %>:
-  <% versions.each do |v| %>&nbsp;
-  <%= text.version == v[0] ? v[0] : 
-      link_to(v[0], method: 'chapter', book_id: chapter.dc_book_id, chapter_id: chapter._id, text_id: v[1] ) %>&nbsp;
-  <% end %>
-</div>
-<div class="book-chapter-prev-next">
-  <%= dc_link_to(prev_chapter.title, 'hand-o-left', method: 'chapter', 
-              book_id: prev_chapter.dc_book.link, chapter_id: prev_chapter.link ) if prev_chapter %>&nbsp;|&nbsp;
-  <%= dc_link_to(' ','hand-o-up', book_id: chapter.dc_book.link, method: 'toc' ) %>&nbsp;|&nbsp;
-  <%= dc_link_to(next_chapter.title, 'hand-o-right', method: 'chapter', 
-              book_id: next_chapter.dc_book.link, chapter_id: next_chapter.link ) if next_chapter %>
-  
-</div>
-<div class="book-chapter-text">
-  <%= if dc_edit_mode?
-    dc_link_for_edit({ controller: 'cmsedit', action: 'edit', id: text._id, ids: chapter._id, 
-        table: 'dc_book_chapter;dc_book_text', title: "#{t('drgcms.edit')}" })
-    end %>
-
-  <%= text.body.html_safe %>
-</div>
-
-<div class="book-replies">
-  <h2><%= t('dc_blog.comments') %></h2>
-  <%= render partial: 'dc_replay/reply', formats: [:html], 
-             locals: { replies: replies, parent_id: chapter.id, parent_document: 'dc_book_chapter' } %>
-</div>
-
-<iframe id="iframe_edit" name="iframe_edit" scrolling="no"></iframe>

data/app/views/dc_manual/_toc.html.erb

@@ -1,10 +0,0 @@
-<div class="book-top"><%= book.title %>
-  <div class="book-contents">
-    <% chapters.each do |chapter| %>
-      <% a=chapter.chapter.split('.'); last=a.last; level=a.size%>
-      <div class="book-contents-level<%= level %>">
-        <%= link_to(chapter.title, method: 'chapter', book_id: chapter.dc_book.link, chapter_id: chapter.link ) %>
-      </div>
-    <% end %>
-  </div>
-</div>