patricia 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef479d8eff067d6a70b52846c246763987cb72e8
-  data.tar.gz: 538feff310e1df73d5f52c79d6da00e054bd268a
+  metadata.gz: 67fe48708657dc1541204315dcaedcb79f04479a
+  data.tar.gz: a3ebb2cc08e9f902773f89aa3c1d4894f9d1ec82
 SHA512:
-  metadata.gz: e22e0b7aa71306f9e4015a98acedc315adf3bf21a38141b1f0f073918c0db23aa202e5fc43fcb38e0731e79755068a5fc86a44d290bc521c5d15bafa74fb952e
-  data.tar.gz: d704365bc2c6e17f7966870f16f07905232899e4c185f4eeca0c7bfe623a49db1ba187fbbff1c4dd51960ff63261fc6dbcc4218ff46f11b9758419c0c248ad89
+  metadata.gz: 60803a1932ff8c839e000a8c1783af3de02e9a5a639e6b8df09c015098a4fa487c9f456974cbf2de51c6a60a14b9a421c0b99fad0790d1b6f979332c10218148
+  data.tar.gz: 6227b21360ab4648b651d0754da183b4c4b97da7a207ff0ef1a7dbd83f92a6a6cfbb2451b97780dbc0f3d9b696dca5b432c8d37221b9f32c48241b6ff61d2155

data/Gemfile

@@ -7,6 +7,7 @@ gem 'kramdown'
 gem 'org-ruby'
 gem 'redcloth'
 gem 'pandoc-ruby'
+gem 'github/markdown'
 gem 'rack'
 gem 'fileutils'
 gem 'sinatra'

data/README.md

@@ -19,6 +19,16 @@ right file extension. Static files (images/PDFs/video/...) in the markup
 directory are served as is, so you can link to them from any page and the
 links will not break.
 
+Patricia also comes with some optional goodies:
+  
+- Basic markup editor (`-e` flag) that allows you to select an element or
+  highlight text on a page and brings up the corresponding markup, if it
+  can figure it out.
+- Tooltips (`-t` flag) which show you the full file path for every
+  directory and file in the sidebar by hovering over it.
+- RegEx search across all pages (if you tag your pages using a consistent
+  pattern, you can use this to get a list of all pages for certain tags).
+
 ## Installation
 
         gem install patricia
@@ -75,3 +85,23 @@ To add support for a new language do this:
    possible, so that browsers will display them on a page instead of
    prompting to download the file.
 5. *Make sure the tests pass*
+
+## Editor
+
+Patricia's rudimentary and completely optional markup editor can
+be enabled using the `-e` flat. It allows you to edit the markup for
+editable components by hovering over them or by simply selecting text. It
+tries its best to figure out which part of the markup is responsible for
+the selected element and highlights it so that one can immediately jump to
+the corresponding markup for quick fixes or even larger changes. Keep in
+mind that this is not perfect, but it definetly is usable and is quite
+handy for a lot of small fixes across multiple files as well as correcting
+typos.
+
+## Page search
+
+There is the search box in the sidebar that allows you to quickly search
+all page titles, but there is also a buillt-in search page that allows you
+to search the actual text of each page using regular expressions. So if you
+include (hash) tags on your pages, you can use this to search all matching
+pages, for instance.

data/bin/patricia

@@ -11,6 +11,8 @@ config = {
   :js_dir => CLI.options[:js],
   :markup_dir => CLI.options[:markup_dir],
   :tooltips => CLI.options[:tooltips],
+  :editor => CLI.options[:editor],
+  :gfm => CLI.options[:gfm],
 }
 config_file = File.dirname(__FILE__) + '/app_config.yml'
 # The thread ensures that the config file is written before the Sinatra app

data/lib/patricia/app.rb

@@ -1,5 +1,7 @@
 require 'sinatra/base'
 require 'yaml'
+require 'json'
+require 'timeout'
 
 
 module PatriciaApp
@@ -36,6 +38,8 @@ module PatriciaApp
         set :app_js_path, '/patricia.js'
         set :app_public_folder, app_configs[:public_folder]
         set :app_tooltips, app_configs[:tooltips]
+        set :app_editor, app_configs[:editor]
+        set :app_gfm, app_configs[:gfm]
         # CSS
         if app_configs[:css_dir] != nil
           set :app_css_dir, app_configs[:css_dir]
@@ -79,10 +83,12 @@ module PatriciaApp
           'sh' => 'application/x-sh',
           '7z' => 'application/x-7z-compressed',
           'swf' => 'application/x-shockwave-flash',
+          'xml' => 'application/xml;charset=utf-8',
           'avi' => 'video/x-msvideo',
           'txt' => 'text/plain',
           'css' => 'text/css',
           'csv' => 'text/csv',
+          'html' => 'text/html',
           # Send markup source files
           #
           # One can argue if this is semantically correct (alternative:
@@ -121,8 +127,14 @@ module PatriciaApp
     end
 
     get '/' do
-      @html = Patricia::Converter .to_html(File.dirname(__FILE__) +
+      if settings.app_gfm
+        html = Patricia::Converter.gfm_to_html(File.dirname(__FILE__) +
+                                               '/views/wiki/welcome.md')
+      else
+        html = Patricia::Converter.to_html(File.dirname(__FILE__) +
                                            '/views/wiki/welcome.md')
+      end
+      @html = '<div id="p-welcome-text-page" class="">' + html + '</div>'
       @toc = build_toc
       @title = generate_page_title
       @page_title = ''
@@ -161,11 +173,11 @@ module PatriciaApp
           beautiful_file_name = capitalize_all(file_name.gsub(/-/, ' '))
           beautiful_path = no_ext.split('/').collect do |s|
             capitalize_all(s.gsub(/-/, ' '))
-          end.join(' > ')
+          end.delete_if(&:empty?).join(' > ')
           content = File.read(path)
           lines = content.split("\n").length
           if content =~ search_query
-            @results << [beautiful_file_name, '/' + no_ext, beautiful_path,
+            @results << [beautiful_file_name, no_ext, beautiful_path,
                          lines]
           end
         end
@@ -173,6 +185,52 @@ module PatriciaApp
       haml :search, :layout => :application
     end
 
+    post %r{/patricia/offsets/?} do
+      if settings.app_editor
+        file_content = File.read(File.join(settings.app_markup_dir,
+                                           params[:markup_url]))
+        offsets = []
+        # Time out if the RegEx is too complex.
+        begin
+          Timeout::timeout(3) do
+            filler = " *\n*\w*"
+            pattern = Regexp.new(filler, Regexp::MULTILINE)
+            params[:string].split.each do |token|
+              pattern =
+                Regexp.new(pattern.to_s + filler + Regexp.quote(token),
+                           Regexp::MULTILINE)
+            end
+            pattern = Regexp.new(pattern.to_s + filler, Regexp::MULTILINE)
+
+            # Skip empty/whitespace only queries.
+            if !pattern.to_s.empty? && !(pattern.to_s =~ /^\s*$/)
+              file_content.scan(pattern) do |c|
+                offsets << [$~.offset(0)[0], $~.offset(0)[1]]
+              end
+            end
+          end
+        rescue
+          # Ignore.
+        end
+
+        content_type 'json'
+        {:markup => file_content, :offsets => offsets}.to_json
+      else
+        redirect to('/404')
+      end
+    end
+
+    post %r{/patricia/edit/?} do
+      if settings.app_editor
+        File.open(File.join(settings.app_markup_dir,
+                            params[:markup_url]), 'w') do |f|
+          f.puts(params[:string])
+        end
+      else
+        redirect to('/404')
+      end
+    end
+
     get settings.app_css_path do
       pwd = File.dirname(__FILE__)
       css = ''
@@ -196,6 +254,7 @@ module PatriciaApp
          '/assets/javascripts/app.js',
         ]
       files << '/assets/javascripts/tooltips.js' if settings.app_tooltips
+      files << '/assets/javascripts/editor.js' if settings.app_editor
       files.each do |path|
         js << File.read(pwd + path) + "\n\n"
       end
@@ -215,7 +274,11 @@ module PatriciaApp
         file_path = Dir[settings.app_markup_dir + '/' + path +
                         settings.app_markdown_glob].first
         @markup_url = file_path.gsub(/#{settings.app_markup_dir}/, '')
-        @html = Patricia::Converter.to_html(file_path)
+        if settings.app_gfm
+          @html = Patricia::Converter.gfm_to_html(file_path)
+        else
+          @html = Patricia::Converter.to_html(file_path)
+        end
         @toc = build_toc
         arrow = ' > '
         @title = generate_page_title

data/lib/patricia/assets/javascripts/app.js

@@ -1,21 +1,20 @@
 $(document).ready(function() {
 
+  var self = $(this);
+
   // Helpers
 
   $.fn.elementText = function() {
-    var str = '';
-    $(this).contents().each(function() {
-      if ($(this).nodeType == 3) {
-        str += $(this).textContent || $(this).innerText || '';
-      }
-    });
-    return str;
+    return $(this).clone().children().remove().end().text();
   };
 
+  // Aesthetical enhancements
+
+  $('table').addClass('table table-striped table-responsive')
+
 
   // Sidebar expanding
 
-  var self = $(this);
   self.sidebarExpanded = false;
   self.originalSidebarStyle = {
     'width': '',
@@ -82,6 +81,11 @@ href="/">Close</a></p>\
 <p><code>s</code><span>: Select sidebar search box</span></p>\
 <p><code>Esc</code><span>: Unselect sidebar search box</span></p>\
 <p><code>p</code><span>: Go to page search page</span></p>\
+<p><code>e</code><span>: Edit selected text</span></p>\
+<strong>Editor textarea:</strong>\
+<p><code>Ctrl</code> + <code>RET</code><span>: Save changes \
+<p><code>Alt</code> + <code>p</code><span>: Go to previous match \
+<p><code>Alt</code> + <code>n</code><span>: Go to next match \
 </div>\
 '
   );
@@ -94,7 +98,7 @@ href="/">Close</a></p>\
     'top': '50%',
     'left': '50%',
     'width': '500px',
-    'height': '400px',
+    'height': '430px',
     'margin-left': '-200px',
     'margin-top': '-300px',
     'z-index': '9999',

data/lib/patricia/assets/javascripts/editor.js

@@ -0,0 +1,269 @@
+$(document).ready(function() {
+
+  var self = $(this);
+
+  // Helpers
+
+  self.getSelectedText = function() {
+    var text  = '';
+    if (window.getSelection) {
+      text = window.getSelection().toString();
+    } else if (document.getSelection) {
+      text = document.getSelection().toString();
+    } else if (document.selection) {
+      text = document.selection.createRange().text;
+    }
+    return text;
+  };
+
+  self.scrollToSelectedText = function(textArea, start, end) {
+    var charsPerRow = textArea.attr('cols');
+    var selectionRow = (start - (start % charsPerRow)) / charsPerRow;
+    var lineHeight = textArea.height() / textArea.attr('rows');
+    textArea.scrollTop(lineHeight * selectionRow +
+                       (textArea.height() / 2));
+  };
+
+
+  // Editing
+
+  self.hoveredText = '';
+  self.hoveredElementBgColor = '';
+  self.hoveredElementHighlightColor = '#DFDFD2';
+  self.editButton = $('#edit-button');
+  self.mouseX = 0;
+  self.mouseY = 0;
+  $(document).mousemove(function(e) {
+    self.mouseX = e.pageX;
+    self.mouseY = e.pageY;
+  });
+
+  self.currentlyHighlightedText = '';
+
+  // Get all leaf node children of `#content'.
+  //
+  // Alternative: The following is a method to get only the first level
+  // children of `#content'.
+  //
+  // $('#content > *:not(:has(*))').hover(function() {
+  //
+  $('#content *').filter(function(index) {
+    var isLeaf = $(this).children().length == 0;
+    return isLeaf;
+  }).hover(function() {
+    if (!$('#p-welcome-text-page').length) {
+      $(this).css({'background-color': self.hoveredElementHighlightColor});
+    }
+    // Postion the edit button
+    if (self.editButton.hasClass('hidden')) {
+      self.editButton.removeClass('hidden');
+    } else {
+      self.editButton.toggle();
+    }
+    var that = $(this);
+    that.setCurrentlyHighlightedText = function() {
+      self.currentlyHighlightedText = that.elementText();
+    };
+    // Append the edit button after setting
+    // `self.currentlyHighlightedText' or else the text will include the
+    // edit button text.
+    $.when(that.setCurrentlyHighlightedText()).done(function() {
+      that.append(self.editButton);
+    });
+  }, function() {
+    $(this).css({'background-color': self.hoveredElementBgColor});
+    // Hide the edit button.
+    self.editButton.toggle();
+    // Remove it from the previous element, but keep it in the DOM. If it
+    // is not in the DOM, it is not clickable.
+    $('body').append(self.editButton);
+  });
+
+  self.offsets = [];
+  self.currentOffset = [];
+  self.currentOffsetIndex = 0;
+  self.textArea = $('#edit-modal textarea');
+  self.editModal = $('#edit-modal');
+  self.editNavigationBox = $('#edit-navigation-box');
+  self.editSelectedText = function() {
+    $.ajax({
+      'type': 'POST',
+      'url': self.editButton.attr('href'),
+      'data': {
+        'string': self.currentlyHighlightedText,
+        'markup_url': self.editButton.attr('data-markup-url'),
+      },
+      'success': function(data, status) {
+        // Show the edit modal
+        self.editModal.modal('show');
+        $('#currently-selected-text-info').text(
+          self.currentlyHighlightedText);
+        self.textArea.val(data['markup']);
+        self.textArea.focus();
+        self.offsets = 0;  // Reset.
+        self.offsets = data['offsets']
+        self.currentOffsetIndex = 0;
+        self.currentOffset = self.offsets[self.currentOffsetIndex] ||
+          [0, 0];
+	$('#current-offset-index').text(self.currentOffsetIndex + 1 +
+					' / ');
+	$('#offsets-length').text(self.offsets.length);
+        if (self.offsets.length > 1) {
+          $('#edit-navigation-box').show();
+          self.editNavigationBox.show();
+        } else {
+          self.editNavigationBox.hide();
+        }
+
+        self.editModal.on('shown.bs.modal', function() {
+          self.textArea.focus();
+          self.textArea[0].setSelectionRange(self.currentOffset[0],
+                                             self.currentOffset[1])
+          self.scrollToSelectedText(self.textArea, self.currentOffset[0],
+                                    self.currentOffset[1]);
+        });
+      },
+      'data-type': 'json',
+    });
+  };
+
+  self.editButton.on('click', function(e) {
+    e.preventDefault();
+    self.leftEditButton.hide();
+    self.editSelectedText();
+  });
+
+  self.leftEditButton = $('#left-edit-button');
+
+  self.leftEditButton.on('click', function(e) {
+    e.preventDefault();
+    // e.stopPropagation();
+    self.leftEditButton.hide();
+    self.editSelectedText();
+  });
+
+  $('#content').on('mouseup', function(e) {
+    if (self.getSelectedText() != '') {
+      self.currentlyHighlightedText = self.getSelectedText();
+    }
+    if (self.getSelectedText() != '') {
+    // if (self.currentlyHighlightedText != '') {
+      if (self.leftEditButton.hasClass('hidden')) {
+        self.leftEditButton.removeClass('hidden');
+        self.leftEditButton.show();
+      } else {
+        self.leftEditButton.show();
+      }
+      self.leftEditButton.css({
+        'position': 'absolute',
+        'top': self.mouseY - (self.leftEditButton.height() + 20),
+        'left': self.mouseX - (self.leftEditButton.width()),
+        'z-index': 9998,
+        'box-shadow': '0px 5px 3px rgba(0, 0, 0, 0.3), \
+0px 0px 8px rgba(102, 175, 233, 0.6)',
+	'background-color': '#121212',
+	'color': '#F1F1F1',
+	'margin-top': '0',
+	'font-weight': 'bold',
+	'border': 'none',
+	'border-radius': '5px',
+	'border': '2px solid #F1F1F1',
+      });
+      self.leftEditButton.animate({
+	'margin-top': '-10px',
+      }, 230);
+    }
+  });
+
+  $('*').not(self.leftEditButton).on('mousedown', function(e) {
+    e.stopPropagation();
+    window.setTimeout(function() {
+      self.leftEditButton.hide();
+    }, 130);
+  });
+
+  $(document).keypress(function() {
+    self.leftEditButton.hide();
+  });
+
+  // Navigation between matches
+
+  $('#previous-match-button').click(function(e) {
+    e.preventDefault();
+    if (self.currentOffsetIndex > 0) {
+      self.currentOffsetIndex -= 1;
+    } else {
+      self.currentOffsetIndex = self.offsets.length - 1;
+    }
+    self.currentOffset = self.offsets[self.currentOffsetIndex];
+    self.textArea.focus();
+    self.textArea[0].setSelectionRange(self.currentOffset[0],
+                                       self.currentOffset[1])
+    self.scrollToSelectedText(self.textArea, self.currentOffset[0],
+                              self.currentOffset[1]);
+    $('#current-offset-index').text(self.currentOffsetIndex + 1 + ' / ');
+  });
+
+  $('#next-match-button').click(function(e) {
+    e.preventDefault();
+    if (self.currentOffsetIndex < self.offsets.length - 1) {
+      self.currentOffsetIndex += 1;
+    } else {
+      self.currentOffsetIndex = 0;
+    }
+    self.currentOffset = self.offsets[self.currentOffsetIndex];
+    self.textArea.focus();
+    self.textArea[0].setSelectionRange(self.currentOffset[0],
+                                       self.currentOffset[1])
+    self.scrollToSelectedText(self.textArea, self.currentOffset[0],
+                              self.currentOffset[1]);
+    $('#current-offset-index').text(self.currentOffsetIndex + 1 + ' / ');
+  });
+
+
+  // 101:  e   - Edit selected text
+  $(document).on('keypress', function(e) {
+    if (e.target.nodeName != 'INPUT' && e.target.nodeName != 'TEXTAREA') {
+      if (e.which == 101) {
+        self.editSelectedText();
+      }
+    }
+  });
+
+  // Saving
+
+  self.saveButton = $('#edit-save-button');
+  self.saveButton.on('click', function() {
+    $.ajax({
+      'type': 'POST',
+      'url': self.saveButton.attr('data-url'),
+      'data': {
+        'markup_url': self.editButton.attr('data-markup-url'),
+        'string': self.textArea.val(),
+      },
+    });
+    location.reload();
+  });
+
+  // 17: Ctrl
+  // 13: RET
+  // 18: Alt
+  // 80: p
+  // 78: n
+  self.keys = {};
+  self.textArea.on('keydown', function(e) {
+    self.keys[e.which] = true;
+    if (self.keys[13] == true && self.keys[17] == true) {
+      self.saveButton.click();
+    } else if (self.keys[18] == true && self.keys[80] == true) {
+      $('#previous-match-button').click();
+    } else if (self.keys[18] == true && self.keys[78] == true) {
+      $('#next-match-button').click();
+    }
+  });
+
+  self.textArea.on('keyup', function(e) {
+    delete self.keys[e.which];
+  });
+
+});

data/lib/patricia/assets/stylesheets/app.css

@@ -20,3 +20,86 @@ img {
   max-width: 100%;
   height: auto;
 }
+
+#edit-button {
+  margin-left: 10px;
+  z-index: 9998;
+}
+
+#edit-modal .modal-dialog {
+  width: 80%;
+}
+
+#edit-modal textarea {
+  font-family: monospace;
+}
+
+/* Page title */
+
+.page-title {
+  line-height: 30px;
+  border-top: 1px solid #E3E3E3;
+}
+
+body {
+  background-color: #F5F5F5;
+  margin-top: 20px;
+}
+
+#content {
+  background-color: #FFFFFF;
+  color: #393939;
+  padding: 25px;
+  border: 1px solid #E3E3E3;
+  border-radius: 4px;
+}
+
+#p-sidebar {
+  background-color: #FFFFFF;
+  color: #393939;
+  border: 1px solid #E3E3E3;
+  border-radius: 4px;
+}
+
+.top-panel {
+  margin-bottom: 40px;
+}
+
+/* Welcome page */
+
+#p-welcome-text-page h1 {
+  background-color: #428BCA;
+  padding: 10px;
+  padding-top: 15px;
+  color: #F1F1F1;
+  border-radius: 5px;
+  text-align: center;
+}
+
+#p-welcome-text-page {
+  border: 5px solid #E3E3E3;
+  background-color: #ECF4FF;
+  padding: 20px;
+  padding-top: 5px;
+  border-radius: 5px;
+}
+
+#p-welcome-text-page h2 {
+  background-color: #FFFFFF;
+  border: 5px solid #428BCA;
+  color: #428BCA;
+  padding: 10px;
+  padding-top: 15px;
+  border-radius: 5px;
+  text-align: center;
+}
+
+#currently-selected-text-info {
+  height: 50px;
+  overflow: hidden;
+  border: none !important;
+}
+
+#currently-selected-text-info:hover {
+  overflow: scroll;
+}

data/lib/patricia/cli.rb

@@ -16,6 +16,11 @@ module CLI
     opts.separator ''
     opts.separator 'Options:'
 
+    opts.on('-p', '--port PORT', Integer,
+            'Port to run the server on') do |v|
+      options[:port] = v
+    end
+
     opts.on('-c', '--css DIR', 'Directory with CSS files to be',
             'included in the output',
             '  (All .css files in this directory',
@@ -35,9 +40,13 @@ module CLI
       options[:tooltips] = v
     end
 
-    opts.on('-p', '--port PORT', Integer,
-            'Port to run the server on') do |v|
-      options[:port] = v
+    opts.on('-e', '--editor', 'Enable markup editor') do |v|
+      options[:editor] = v
+    end
+
+    opts.on('-g', '--gfm',
+            'Use GitHub Flavored Markdown for all', '  rendering') do |v|
+      options[:gfm] = v
     end
 
     # Description

data/lib/patricia/patricia.rb

@@ -3,6 +3,7 @@ require 'kramdown'
 require 'org-ruby'
 require 'redcloth'
 require 'pandoc-ruby'
+require 'github/markup'
 
 
 module Patricia
@@ -51,10 +52,13 @@ module Patricia
     end
 
     def self.to_html(path)
-      markup = File.open(path, 'r').read
+      markup = File.read(path)
       self.send @@converters[File.extname(path).sub(/^\./, '')], markup
     end
 
+    def self.gfm_to_html(path)
+      GitHub::Markup.render(path)
+    end
   end
 
   class Wiki

data/lib/patricia/version.rb

@@ -1,3 +1,3 @@
 module Patricia
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/patricia/views/wiki/page.haml

@@ -1,21 +1,23 @@
 %br
 %div.container
   %div.row
-    %div.col.col-md-7.col-md-offset-1#content
-      %div.row
-        %div.col.col-md-8
-          %a{:href => "/"}
-            %strong= @title if defined?(@title)
-          - if defined?(@page_title)
-            - if !@page_title.empty?
-              |
-          %span.text-muted= @breadcrumb
-          = @page_title if defined?(@page_title)
-        %div.col.col-md-4
+    %div.col.col-md-7.col-md-offset-1
+      %div.row.panel.panel-default.panel-body.top-panel
+        %div.col.col-md-9
+          %p
+            %strong
+              %a{:href => "/"}= @title if defined?(@title)
+        %div.col.col-md-3
           %p.text-right
             %a.text-muted.small#p-page-search-link{:href => "/patricia/search"} Search pages >
-      %hr
-      = @html if defined?(@html)
+        %div.row
+          %div.col.col-md-12.page-title
+            %span.text-muted= @breadcrumb
+            = @page_title if defined?(@page_title)
+
+      %div.row#content
+        = preserve do
+          = @html if defined?(@html)
       %hr
       - if defined?(@markup_url)
         %p.text-center
@@ -29,3 +31,29 @@
       - if defined?(@toc)
         %div#toc
           = @toc
+- if defined?(@markup_url)
+  %a.hidden#edit-button{:href => "/patricia/offsets", 'data-markup-url' => "#{@markup_url}"} Edit
+  %a.hidden#left-edit-button.btn.btn-default{:href => "/patricia/offsets", 'data-markup-url' => "#{@markup_url}"} Edit
+
+%div.modal.fade#edit-modal{:tabindex => '-1', :role => 'dialog'}
+  %div.modal-dialog.modal-lg
+    %div.modal-content
+      %div.modal-header
+        %button.close{:type => 'button', 'data-dismiss' => 'modal', 'aria-hidden' => 'true'} ×
+        %h4.no-style.modal-title Edit Page Markup
+      %div.modal-body
+        %pre#currently-selected-text-info{:title => 'Selected text', 'data-toggle' => 'tooltip', 'data-placement' => 'top'}
+        %textarea.form-control{:rows => 15, :cols => 100}
+        %div.container#edit-navigation-box
+          %div.row
+            %br
+            %div.col-md-2.col-md-offset-3
+              %a#previous-match-button.btn.btn-default.btn-block{:href => '#'} < Previous match
+            %div.col-md-1
+              %span#current-offset-index
+              %span#offsets-length
+            %div.col-md-2
+              %a#next-match-button.btn.btn-default.btn-block{:href => '#'} Next match >
+      %div.modal-footer
+        %button.btn.btn-default{:type => 'button', 'data-dismiss' => 'modal'} Cancel
+        %button.btn.btn-primary#edit-save-button{:type => 'button', 'data-dismiss' => 'modal', 'data-url' => '/patricia/edit'} Save

data/lib/patricia/views/wiki/welcome.md

@@ -93,8 +93,34 @@ user, run:
 ## Sidebar
 
 - The search box is case-insensitive, but otherwise RegEx-aware.
-
 - The sidebar can be widened. Click `Widen sidebar` or hit the `w` key.
+- Hit `s` to focus the search bar from wherever you are on a page.
+
+## Editor
+
+- Use the `-e` flag to enable the editor.
+- There are three ways to edit text:
+  1. Hover over elements. Editable elements will present you with an `Edit`
+     link.
+  2. Hover over an editable element and press the `e` key.
+  3. Highlight some arbitrary text and press the `Edit` button that appears
+     or hit the `e` key.
+- Patricia tries to figure out which markup source matches the selected
+  text. If there are multiple matches, you can step through all of them.
+
+## Tooltips
+
+... can be enabled using the `-t` flag and will show tooltips for every
+sidebar item.
+
+## Page Search
+
+- There is a `Search pages` link on every page.
+- The search is performed across all markup source files and will return a
+  list of matching pages.
+- Regular expressions can be used.
+
+## Keyboard Shortcuts
 
 - Press `?` to get a list of all keyboard shortcuts.
 

data/spec/app_spec.rb

@@ -25,6 +25,7 @@ describe "PatriciaApp::App" do
         :css_dir => nil,
         :js_dir => nil,
         :tooltips => false,
+        :editor => true,
       }
       load_config(config)
     end
@@ -69,8 +70,8 @@ request" do
       end
 
       describe "Markup language: reStructuredText" do
-        it "reads a reStructuredText file and renders it as HTML upon a GET \
-request" do
+        it "reads a reStructuredText file and renders it as HTML upon a \
+GET request" do
           get '/colors/light-pink'
           expect(last_response).to be_ok
           expect(last_response.body)
@@ -83,8 +84,18 @@ request" do
     describe "Return static files" do
       describe "Static file: PNG image" do
         it "returns a PNG image uppon a GET request" do
-          get '/colors/red.md'
+          get '/colors/image.png'
+          expect(last_response).to be_ok
+          expect(last_response.headers['Content-Type']).to eq('image/png')
+        end
+      end
+
+      describe "Static file: HTML image" do
+        it "returns a HTML image uppon a GET request" do
+          get '/colors/cyan.html'
           expect(last_response).to be_ok
+          expect(last_response.headers['Content-Type'])
+            .to eq('text/html;charset=utf-8')
         end
       end
 
@@ -142,6 +153,24 @@ upon a GET request" do
       end
     end
 
+    # Page Editing
+
+    describe "Page Editing" do
+      it "finds all matches for a sting in a page's markup and returns \
+the markup together with the match offsets (POST)" do
+        post '/patricia/offsets', {:markup_url =>
+          'colors/red.md', :string => 'red'}
+        expect(last_response).to be_ok
+      end
+
+      # it "updates the markup for a page with new markup (POST)" do
+      #   new_markup = "# New markup\n\nThis is some *new* markup.\n"
+      #   post '/patricia/edit', {:markup_url =>
+      #     'colors/red.md', :string => new_markup}
+      #   expect(last_response).to be_ok
+      # end
+    end
+
   end
 
   describe "Use custom CSS and JavaScript" do
@@ -152,6 +181,7 @@ upon a GET request" do
         :js_dir => File.join(File.dirname(__FILE__),
                              'assets/javascripts/'),
         :tooltips => false,
+        :editor => false,
       }
       load_config(config)
     end

data/spec/random-test-wiki/colors/cyan.html

@@ -0,0 +1,18 @@
+<html>
+  <head>
+    <title>Cyan</title>
+    <link rel="stylesheet" href="" type="text/css" />
+  </head>
+  
+  <body>
+
+    <h1>Color: Cyan</h1>
+    <h2>Description</h2>
+    <p>This is cyan.</p>
+    <hr />
+    <h2>Info</h2>
+    <p>Here is some info.</p>
+    
+    <script type="text/javascript" src=""></script>
+  </body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patricia
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - nounch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,6 +57,7 @@ files:
 - lib/patricia/app.rb
 - lib/patricia/assets/javascripts/app.js
 - lib/patricia/assets/javascripts/bootstrap.min.js
+- lib/patricia/assets/javascripts/editor.js
 - lib/patricia/assets/javascripts/jquery-1.11.0.min.js
 - lib/patricia/assets/javascripts/tooltips.js
 - lib/patricia/assets/stylesheets/app.css
@@ -85,6 +86,7 @@ files:
 - spec/random-test-wiki/amazing-animals/tall/giraffe.md
 - spec/random-test-wiki/colors/blue.md
 - spec/random-test-wiki/colors/bright-orange.org
+- spec/random-test-wiki/colors/cyan.html
 - spec/random-test-wiki/colors/dark-yellow.textile
 - spec/random-test-wiki/colors/file.txt
 - spec/random-test-wiki/colors/green.markdown
@@ -132,6 +134,7 @@ test_files:
 - spec/random-test-wiki/amazing-animals/tall/giraffe.md
 - spec/random-test-wiki/colors/blue.md
 - spec/random-test-wiki/colors/bright-orange.org
+- spec/random-test-wiki/colors/cyan.html
 - spec/random-test-wiki/colors/dark-yellow.textile
 - spec/random-test-wiki/colors/file.txt
 - spec/random-test-wiki/colors/green.markdown