doc/README_md.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>README - RDoc Documentation</title>
<link href="./fonts.css" rel="stylesheet">
<link href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script src="./js/jquery.js"></script>
<script src="./js/navigation.js"></script>
<script src="./js/search_index.js"></script>
<script src="./js/search.js"></script>
<script src="./js/searcher.js"></script>
<script src="./js/darkfish.js"></script>
<body id="top" role="document" class="file">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#label-rails_embed_editor">rails_embed_editor</a>
<li><a href="#label-Installation">Installation</a>
<li><a href="#label-How+it+work">How it work</a>
</ul>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="nav-section">
<h3>Pages</h3>
<ul class="link-list">
<li><a href="./Gemfile.html">Gemfile</a>
<li><a href="./Gemfile_lock.html">Gemfile.lock</a>
<li><a href="./LICENSE.html">LICENSE</a>
<li><a href="./MIT-LICENSE.html">MIT-LICENSE</a>
<li><a href="./README_md.html">README</a>
<li><a href="./README_rdoc.html">README</a>
<li><a href="./Rakefile.html">Rakefile</a>
<li><a href="./app/assets/javascripts/rails_embed_editor/application_coffee.html">application.coffee</a>
<li><a href="./app/assets/stylesheets/rails_embed_editor/application_scss.html">application.scss</a>
<li><a href="./doc/ActiveSupport_html.html">ActiveSupport.html</a>
<li><a href="./doc/ApplicationController_html.html">ApplicationController.html</a>
<li><a href="./doc/ApplicationHelper_html.html">ApplicationHelper.html</a>
<li><a href="./doc/ConfigTest_html.html">ConfigTest.html</a>
<li><a href="./doc/Dummy_html.html">Dummy.html</a>
<li><a href="./doc/Dummy/Application_html.html">Application.html</a>
<li><a href="./doc/EditorControllerTest_html.html">EditorControllerTest.html</a>
<li><a href="./doc/FileManagerTest_html.html">FileManagerTest.html</a>
<li><a href="./doc/Gemfile_html.html">Gemfile.html</a>
<li><a href="./doc/Gemfile_lock_html.html">Gemfile_lock.html</a>
<li><a href="./doc/LICENSE_html.html">LICENSE.html</a>
<li><a href="./doc/Logger_html.html">Logger.html</a>
<li><a href="./doc/MIT-LICENSE_html.html">MIT-LICENSE.html</a>
<li><a href="./doc/NavigationTest_html.html">NavigationTest.html</a>
<li><a href="./doc/Object_html.html">Object.html</a>
<li><a href="./doc/README_md_html.html">README_md.html</a>
<li><a href="./doc/README_rdoc_html.html">README_rdoc.html</a>
<li><a href="./doc/RailsEmbedEditor_html.html">RailsEmbedEditor.html</a>
<li><a href="./doc/RailsEmbedEditor/ApplicationController_html.html">ApplicationController.html</a>
<li><a href="./doc/RailsEmbedEditor/ApplicationHelper_html.html">ApplicationHelper.html</a>
<li><a href="./doc/RailsEmbedEditor/Config_html.html">Config.html</a>
<li><a href="./doc/RailsEmbedEditor/EditorController_html.html">EditorController.html</a>
<li><a href="./doc/RailsEmbedEditor/EditorMode_html.html">EditorMode.html</a>
<li><a href="./doc/RailsEmbedEditor/Engine_html.html">Engine.html</a>
<li><a href="./doc/RailsEmbedEditor/FileManager_html.html">FileManager.html</a>
<li><a href="./doc/RailsEmbedEditorTest_html.html">RailsEmbedEditorTest.html</a>
<li><a href="./doc/Rakefile_html.html">Rakefile.html</a>
<li><a href="./doc/app/assets/javascripts/rails_embed_editor/application_coffee_html.html">application_coffee.html</a>
<li><a href="./doc/app/assets/stylesheets/rails_embed_editor/application_scss_html.html">application_scss.html</a>
<li><a href="./doc/fonts_css.html">fonts.css</a>
<li><a href="./doc/gemfiles/Gemfile_rails-4_0_x_html.html">Gemfile_rails-4_0_x.html</a>
<li><a href="./doc/index_html.html">index.html</a>
<li><a href="./doc/js/darkfish_js.html">darkfish.js</a>
<li><a href="./doc/js/jquery_js.html">jquery.js</a>
<li><a href="./doc/js/navigation_js.html">navigation.js</a>
<li><a href="./doc/js/search_js.html">search.js</a>
<li><a href="./doc/js/search_index_js.html">search_index.js</a>
<li><a href="./doc/js/searcher_js.html">searcher.js</a>
<li><a href="./doc/lib/tasks/rails_embed_editor_tasks_rake_html.html">rails_embed_editor_tasks_rake.html</a>
<li><a href="./doc/rails_embed_editor_gemspec_html.html">rails_embed_editor_gemspec.html</a>
<li><a href="./doc/rdoc_css.html">rdoc.css</a>
<li><a href="./doc/table_of_contents_html.html">table_of_contents.html</a>
<li><a href="./doc/test/dummy/README_rdoc_html.html">README_rdoc.html</a>
<li><a href="./doc/test/dummy/Rakefile_html.html">Rakefile.html</a>
<li><a href="./doc/test/dummy/app/assets/javascripts/application_js_html.html">application_js.html</a>
<li><a href="./doc/test/dummy/app/assets/stylesheets/application_css_html.html">application_css.html</a>
<li><a href="./doc/test/dummy/config_ru_html.html">config_ru.html</a>
<li><a href="./doc/test/dummy/db/test_sqlite3_html.html">test_sqlite3.html</a>
<li><a href="./doc/test/dummy/log/development_log_html.html">development_log.html</a>
<li><a href="./doc/test/dummy/log/test_log_html.html">test_log.html</a>
<li><a href="./doc/test/dummy/public/404_html_html.html">404_html.html</a>
<li><a href="./doc/test/dummy/public/422_html_html.html">422_html.html</a>
<li><a href="./doc/test/dummy/public/500_html_html.html">500_html.html</a>
<li><a href="./doc/test/dummy/public/favicon_ico_html.html">favicon_ico.html</a>
<li><a href="./gemfiles/Gemfile_rails-4_0_x.html">Gemfile.rails-4.0.x</a>
<li><a href="./lib/tasks/rails_embed_editor_tasks_rake.html">rails_embed_editor_tasks.rake</a>
<li><a href="./rails_embed_editor_gemspec.html">rails_embed_editor.gemspec</a>
<li><a href="./test/dummy/README_rdoc.html">README</a>
<li><a href="./test/dummy/Rakefile.html">Rakefile</a>
<li><a href="./test/dummy/app/assets/javascripts/application_js.html">application.js</a>
<li><a href="./test/dummy/app/assets/stylesheets/application_css.html">application.css</a>
<li><a href="./test/dummy/config_ru.html">config.ru</a>
<li><a href="./test/dummy/db/test_sqlite3.html">test.sqlite3</a>
<li><a href="./test/dummy/log/development_log.html">development.log</a>
<li><a href="./test/dummy/log/test_log.html">test.log</a>
<li><a href="./test/dummy/public/404_html.html">404.html</a>
<li><a href="./test/dummy/public/422_html.html">422.html</a>
<li><a href="./test/dummy/public/500_html.html">500.html</a>
<li><a href="./test/dummy/public/favicon_ico.html">favicon.ico</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-label="Page README.md">
<h1 id="label-rails_embed_editor">rails_embed_editor<span><a href="#label-rails_embed_editor">¶</a> <a href="#documentation">↑</a></span></h1>
<p><a href="https://travis-ci.org/timcolonel/rails_embed_editor"><img
src="https://travis-ci.org/timcolonel/rails_embed_editor.svg?branch=master"></a>
<a
href="https://coveralls.io/r/timcolonel/rails_embed_editor?branch=master"><img
src="https://coveralls.io/repos/timcolonel/rails_embed_editor/badge.png?branch=master"></a>
<a href="https://codeclimate.com/github/timcolonel/rails_embed_editor"><img
src="https://codeclimate.com/github/timcolonel/rails_embed_editor.png"></a></p>
<h1 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#documentation">↑</a></span></h1>
<p>Install the gem <code>ruby gem 'rails_embed_editor', :github =>
'timcolonel/rails_embed_editor' </code> Include the assests <code>erb
<%= javascript_include_tag 'rails_embed_editor/application' if
Rails.env.development? %> <%= stylesheet_link_tag
'rails_embed_editor/application' if Rails.env.development? %> </code></p>
<h1 id="label-How+it+work">How it work<span><a href="#label-How+it+work">¶</a> <a href="#documentation">↑</a></span></h1>
<p>Use the method helper to generate an editor <code>ruby
rails_embed_editor(somefile, options) </code></p>
<p>You can give the follwoing options: * <code>first_line</code> The first
line to read * <code>last_line</code> The last line to read *
<code>line</code> The line where the editor will be centered(To be used
with <code>radius</code>) * <code>radius</code> The radius around the given
line (To be used with <code>line</code>) * <code>readonly</code> If the
editor is for showing only</p>
<p>Example: (This will read 2 line around line 5 in the file
<code>welcome/how.html.erb</code>) <code>erb <%=
rails_embed_editor("#{Rails.root}/app/views/welcome/show.html.erb",
:line => 5, :radius => 2, :readonly => true) %> </code></p>
<p>This is what the editor looks like <img
src="https://f.cloud.github.com/assets/1031227/2528947/4a6d1588-b515-11e3-99f2-3d6a6627d8fe.PNG"></p>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>