Finish Erlang documentation

assets/javascripts/news.json

@@ -1,7 +1,7 @@
 [
   [
     "2016-01-31",
-    "New documentation: <a href=\"/tcl_tk/\">Tcl/Tk</a>"
+    "New documentations: <a href=\"/erlang/\">Erlang</a> and <a href=\"/tcl_tk/\">Tcl/Tk</a>"
   ], [
     "2016-01-24",
     "&ldquo;Multi-version support&rdquo; has landed!\nClick <a href=\"#\" data-pick-docs>Select documentation</a> to pick which versions to use. More versions will be added in the coming weeks.\nIf you notice any bugs, please report them on <a href=\"https://github.com/Thibaut/devdocs/issues\" target=\"_blank\">GitHub</a>."

assets/javascripts/templates/pages/about_tmpl.coffee

@@ -154,6 +154,11 @@ credits = [
     '2012 Plataformatec',
     'Apache',
     'https://raw.githubusercontent.com/elixir-lang/elixir/master/LICENSE'
+  ], [
+    'Erlang',
+    '1999-2015 Ericsson AB',
+    'Apache',
+    'https://raw.githubusercontent.com/erlang/otp/maint/LICENSE.txt'
   ], [
     'Express',
     '2009-2015 TJ Holowaychuk',

assets/stylesheets/global/_icons.scss

@@ -123,3 +123,4 @@
 ._icon-relay:before         { background-position: -8rem -9rem; }
 ._icon-phoenix:before       { background-position: -9rem -9rem; }
 ._icon-tcl_tk:before        { background-position: 0 -10rem; }
+._icon-erlang:before        { background-position: -1rem -10rem; }

assets/stylesheets/pages/_erlang.scss

@@ -1,14 +1,8 @@
-.REFBODY {
+._erlang {
-  margin-bottom: 20px;
+  @extend %simple;
-}
+
-.REFBODY+p {
+  h3.code { @extend %code; }
-  margin-top: 30px;
+  .note { @extend %note; }
-  margin-bottom: 5px;
+  .warning { @extend %note, %note-red; }
-}
+  .note .label, .warning .label { font-weight: bold; }
-.function-name {
-  font-family: $monoFont;
-  display: block;
-  margin: 0;
-  min-height: none;
-  font-weight: bold;
 }

lib/docs/filters/erlang/attribution.rb

@@ -1,9 +0,0 @@
-module Docs
-  class Erlang
-    class AttributionFilter < Docs::AttributionFilter
-      def attribution_link
-        %(<a href="#{base_url}" class="_attribution-link">#{base_url}</a>)
-      end
-    end
-  end
-end

lib/docs/filters/erlang/clean_html.rb

@@ -2,10 +2,106 @@ module Docs
   class Erlang
     class CleanHtmlFilter < Filter
       def call
-        css('#leftnav').remove
+        @doc = at_css('#content .innertube')
-        css('#content .innertube center:last-child').remove
+
-        css('.function-name+br').remove
+        # frontpage
-        css('#content .footer').remove
+
+        css('center:last-child').remove # copyright
+
+        css('center').each do |node|
+          node.before(node.children).remove
+        end
+
+        css('> br').remove
+
+        css('> font[size="+1"]:first-child').each do |node|
+          node.name = 'h1'
+        end
+
+        css('p > b:first-child:last-child > font[size="+1"]').each do |node|
+          node = node.parent.parent
+          node.name = 'h2'
+          node.content = node.content
+        end
+
+        css('font').each do |node|
+          node.before(node.children).remove
+        end
+
+        # others
+
+        # css('p > br:last-child').remove
+
+        css('a[name]').each do |node|
+          parent = node.parent
+          parent = parent.parent while parent.name == 'span'
+          parent['id'] = node['name']
+          node.before(node.children).remove
+        end
+
+        css('h3').each do |node|
+          node.name = 'h2'
+          content = node.content
+          node.content = content.capitalize if content == content.upcase
+        end
+
+        css('p > span.bold_code:first-child ~ br:last-child').each do |node|
+          parent = node.parent
+          parent.name = 'h3'
+          parent['class'] = 'code'
+          parent.css('*:not(a):not(br)').each { |n| n.before(n.children).remove }
+          node.remove
+          parent.inner_html = parent.inner_html.strip
+        end
+
+        css('span.code').each do |node|
+          node.name = 'code'
+        end
+
+        css('pre *:not(a)').each do |node|
+          node.before(node.children).remove
+        end
+
+        css('pre').each do |node|
+          node.inner_html = node.inner_html.strip_heredoc
+        end
+
+        css('.REFBODY').each do |node|
+          if node.element_children.length == 0
+            node.name = 'p'
+          else
+            node.before(node.children).remove
+          end
+        end
+
+        css('.REFTYPES').each do |node|
+          next unless node.parent
+          html = "<pre>"
+          while node['class'] == 'REFTYPES'
+            node.inner_html = node.inner_html.remove(/\n/).gsub('<br>', "\n")
+            node.css('*:not(a)').each { |n| n.before(n.children).remove }
+            html << node.inner_html.strip + "\n"
+            node = node.next_element
+            node.previous_element.remove
+          end
+          html.strip!
+          html << "</pre>"
+          node.before(html)
+        end
+
+        css('.REFTYPES').remove
+
+        css('table').each do |node|
+          node.remove_attribute('border')
+          node.remove_attribute('cellpadding')
+          node.remove_attribute('cellspacing')
+        end
+
+        css('td').each do |node|
+          node.remove_attribute('align')
+          node.remove_attribute('valign')
+        end
+
         doc
       end
     end

lib/docs/filters/erlang/entries.rb

@@ -1,42 +1,34 @@
 module Docs
   class Erlang
     class EntriesFilter < Docs::EntriesFilter
-
       def get_name
-        at_css('h1').try(:content).try(:strip)
+        name = at_css('h1').content.strip
+        name.prepend 'Guide: ' if doc.inner_html.include?('<strong>User\'s Guide</strong>')
+        name
       end
 
       def get_type
-        return nil if 'STDLIB Reference Manual' == name
+        type = subpath[/lib\/(.+?)[\-\/]/, 1]
-        name
+        type << "/#{name}" if type == 'stdlib' && entry_nodes.length >= 10
+        type
       end
 
-      def additional_entries
+      def include_default_entry?
-        css('div.REFBODY+p > a').map do |node|
+        !at_css('.frontpage')
-
+      end
-          id = node.attribute('name').value
-
-          # Here, "node" represents an empty <a> tag. It will later be removed
-          # by CleanTextFilter.
-          # We need to pass its id attribute to another element in order to
-          # make the function anchors in the sidebar work properly.
-          node.next_sibling['id'] = id
-          node.next_sibling['class'] = 'function-name'
-
-          if id == name
-            # Module index page
-            [name, id, name]
-          else
-            # Erlang functions are identified
-            # by name + arity (no. of parameters).
-            # The notation is func_name/arity
 
-            # Replaces the last hyphen with a slash.
+      def additional_entries
-            # E.g: to_string-3 becomes to_string/3
+        entry_nodes.map do |node|
-            function_name = id.gsub(/\-(?<arity>.*)$/, '/\k<arity>')
+          id = node['name']
-            ["#{name}:" + function_name, id, name]
+          name = id.gsub %r{\-(?<arity>.*)\z}, '/\k<arity>'
+          name.remove! 'Module:'
+          name.prepend "#{self.name}:"
+          [name, id]
         end
       end
+
+      def entry_nodes
+        @entry_nodes ||= css('div.REFBODY + p > a')
       end
     end
   end

lib/docs/filters/erlang/pre_clean_html.rb

@@ -0,0 +1,10 @@
+module Docs
+  class Erlang
+    class PreCleanHtmlFilter < Filter
+      def call
+        css('.flipMenu li[title] > a').remove
+        doc
+      end
+    end
+  end
+end

lib/docs/scrapers/erlang.rb

@@ -1,40 +1,43 @@
 module Docs
   class Erlang < FileScraper
-    self.version = '18.1'
     self.type = 'erlang'
-    self.dir = File.expand_path('~/devdocs/erlang')
-    self.base_url = 'http://www.erlang.org/doc/'
     self.root_path = 'doc/index.html'
     self.links = {
-      home: 'http://erlang.org/'
+      home: 'https://www.erlang.org/',
+      code: 'https://github.com/erlang/otp'
     }
 
+    html_filters.insert_after 'container', 'erlang/pre_clean_html'
     html_filters.push 'erlang/entries', 'erlang/clean_html'
 
-    # The folder structure of the offline documentation
+    options[:only_patterns] = [/\Alib/]
-    # differs from the online structure. We need
-    # to replace the attribution filter to generate the
-    # right attribution_link
-    text_filters.replace 'attribution', 'erlang/attribution'
 
-    # Do not scrape these unnecessary links
     options[:skip_patterns] = [
-      /\.pdf$/,
+      /pdf/,
-      /users_guide\.html$/,
+      /release_notes/,
-      /release_notes\.html$/,
+      /result/,
-      /\/html\/.*_app\.html$/,
+      /java/,
-      /\/html\/unicode_usage\.html$/,
+      /\/html\/.*_app\.html\z/,
-      /\/html\/io_protocol\.html$/
+      /_examples\.html\z/,
+      /\Alib\/edoc/,
+      /\Alib\/erl_docgen/,
+      /\Alib\/hipe/,
+      /\Alib\/ose/,
+      /\Alib\/test_server/,
+      /\Alib\/jinterface/,
+      /\Alib\/wx/,
+      /\Alib\/ic/,
+      /\Alib\/Cos/i
     ]
 
-    options[:title] = false
-
-    # Scrape stdlib documentation only
-    options[:only_patterns] = [/stdlib/]
-
     options[:attribution] = <<-HTML
-      Copyright &copy; 1999-2015 Ericsson AB<br>
+      &copy; 1999&ndash;2015 Ericsson AB<br>
       Licensed under the Apache License, Version 2.0.
     HTML
+
+    version '18' do
+      self.release = '18.2'
+      self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang18'
+    end
   end
 end

public/icons/docs/erlang/SOURCE

@@ -1,2 +1 @@
-http://www.pixelstech.net/images/icons/article_type/Erlang_logo.png
+https://github.com/Kapeli/Dash-X-Platform-Resources
-https://s3.amazonaws.com/cloud.ohloh.net/attachments/1364/erlang2_small.png