History

Update DOM documentation

Thibaut committed 12 years ago

Commit b60e6021 parent d6168cf2 files · +36 −13Browse files

Showing the changes to lib/docs (2 of 2 files). Show all

Unified · Split

2 files
  1. lib/docs/filters/dom/entries.rb +10 −5
  2. lib/docs/scrapers/mdn/dom.rb +26 −8
lib/docs/filters/dom/entries.rb+10−5
@@ -11,15 +11,18 @@ module Docs · 10 unmodified lines
11 'Geolocation' => 'Geolocation',11 'Geolocation' => 'Geolocation',
12 'Media Capture' => 'Media',12 'Media Capture' => 'Media',
13 'Media Source' => 'Media',13 'Media Source' => 'Media',
14 'MediaStream' => 'MediaRecorder',
14 'Navigation Timing' => 'Navigation Timing',15 'Navigation Timing' => 'Navigation Timing',
15 'Network Information' => 'Network Information',16 'Network Information' => 'Network Information',
16 'Web Audio' => 'Web Audio',17 'Web Audio' => 'Web Audio',
17 'Web Workers' => 'Web Workers' }18 'Web Workers' => 'Web Workers',
19 'WebRTC' => 'WebRTC' }
18 20
19 TYPE_BY_NAME_STARTS_WITH = {21 TYPE_BY_NAME_STARTS_WITH = {
22 'Audio' => 'Audio',
20 'Canvas' => 'Canvas',23 'Canvas' => 'Canvas',
21 'ChildNode' => 'Node',24 'ChildNode' => 'Node',
22 'console' => 'Console',25 'Console' => 'Console',
23 'CSS' => 'CSS',26 'CSS' => 'CSS',
24 'document' => 'Document',27 'document' => 'Document',
25 'DocumentFragment' => 'DocumentFragment',28 'DocumentFragment' => 'DocumentFragment',
@@ -31,12 +34,14 @@ module Docs · 5 unmodified lines
31 'GlobalEventHandlers' => 'GlobalEventHandlers',34 'GlobalEventHandlers' => 'GlobalEventHandlers',
32 'history' => 'History',35 'history' => 'History',
33 'IDB' => 'IndexedDB',36 'IDB' => 'IndexedDB',
37 'IndexedDB' => 'IndexedDB',
34 'Location' => 'Location',38 'Location' => 'Location',
35 'navigator' => 'Navigator',39 'navigator' => 'Navigator',
36 'Node' => 'Node',40 'Node' => 'Node',
37 'Notification' => 'Notification',41 'Notification' => 'Notification',
38 'ParentNode' => 'Node',42 'ParentNode' => 'Node',
39 'Range' => 'Range',43 'Range' => 'Range',
44 'RTC' => 'WebRTC',
40 'Selection' => 'Selection',45 'Selection' => 'Selection',
41 'StyleSheet' => 'CSS',46 'StyleSheet' => 'CSS',
42 'SVG' => 'SVG',47 'SVG' => 'SVG',
@@ -104,9 +109,9 @@ module Docs · 61 unmodified lines
104 end109 end
105 110
106 def include_default_entry?111 def include_default_entry?
107 !(node = doc.at_css '.overheadIndicator') ||112 (node = doc.at_css '.overheadIndicator').nil? ||
108 !node.content.include?('not on a standards track') &&113 type == 'Console' ||
109 !node.content.include?('removed from the Web')114 (node.content.exclude?('not on a standards track') && node.content.exclude?('removed from the Web'))
110 end115 end
111 end116 end
112 end117 end
lib/docs/scrapers/mdn/dom.rb+26−8
@@ -10,11 +10,9 @@ module Docs · 9 unmodified lines
10 # Don't want10 # Don't want
11 options[:skip] = %w(11 options[:skip] = %w(
12 /App12 /App
13 /Apps
14 /CallEvent13 /CallEvent
15 /CanvasPixelArray14 /CanvasPixelArray
16 /ChromeWorker15 /ChromeWorker
17 /ContactManager
18 /document.createProcessingInstruction16 /document.createProcessingInstruction
19 /document.documentURIObject17 /document.documentURIObject
20 /document.loadOverlay18 /document.loadOverlay
@@ -33,9 +31,10 @@ module Docs · 12 unmodified lines
33 /PowerManager31 /PowerManager
34 /PushManager32 /PushManager
35 /ProcessingInstruction33 /ProcessingInstruction
36 /select.type
37 /TCPServerSocket34 /TCPServerSocket
38 /TCPSocket35 /TCPSocket
36 /TypeInfo
37 /Web_Video_Text_Tracks_Format
39 /WifiManager38 /WifiManager
40 /window.controllers39 /window.controllers
41 /window.crypto40 /window.crypto
@@ -48,7 +47,6 @@ module Docs · 6 unmodified lines
48 /window.navigator.requestWakeLock47 /window.navigator.requestWakeLock
49 /window.updateCommands48 /window.updateCommands
50 /window.pkcs1149 /window.pkcs11
51 /XMLDocument
52 /XMLHttpRequest/Using_XMLHttpRequest)50 /XMLHttpRequest/Using_XMLHttpRequest)
53 51
54 options[:skip_patterns] = [52 options[:skip_patterns] = [
@@ -57,20 +55,29 @@ module Docs · 2 unmodified lines
57 /moz/i,55 /moz/i,
58 /gecko/i,56 /gecko/i,
59 /webkit/i,57 /webkit/i,
58 /gamepad/i,
59 /UserData/,
60 /\A\/Camera/,60 /\A\/Camera/,
61 /\A\/DeviceStorage/,61 /\A\/DeviceStorage/,
62 /\A\/document\.xml/,62 /\A\/document\.xml/,
63 /\A\/XMLDocument/,
63 /\A\/DOMCursor/,64 /\A\/DOMCursor/,
64 /\A\/DOMRequest/,65 /\A\/DOMRequest/,
65 /\A\/element\.on/,66 /\A\/element\.on/,
66 /\A\/Entity/,67 /\A\/Entity/,
67 /\A\/HTMLIFrameElement\./,
68 /\A\/navigator\.id/i,68 /\A\/navigator\.id/i,
69 /\A\/Settings/,69 /\A\/Settings/,
70 /\A\/Telephony/,70 /\A\/Telephony/,
71 /\A\/Bluetooth/,71 /\A\/Bluetooth/,
72 /UserData/,72 /\A\/Window\.\w+bar/i,
73 /\A\/Window\.\w+bar/i]73 /\A\/CSS_Object_Model\//,
74 /\A\/Web_Audio_API\//,
75 /\A\/IndexedDB_API\//,
76 /\A\/MediaRecorder_API\//,
77 /\A\/Apps/,
78 /\A\/Contact/,
79 /\A\/L10n/,
80 /\A\/Permission/]
74 81
75 # Broken / Empty82 # Broken / Empty
76 options[:skip].concat %w(83 options[:skip].concat %w(
@@ -86,7 +93,13 @@ module Docs · 9 unmodified lines
86 /Window.QueryInterface)93 /Window.QueryInterface)
87 94
88 # Duplicates95 # Duplicates
89 options[:skip].concat %w(/Reference)96 options[:skip].concat %w(
97 /Reference
98 /Index
99 /form.elements
100 /select.type
101 /table.rows
102 /XMLHttpRequest/FormData)
90 103
91 options[:fix_urls] = ->(url) do104 options[:fix_urls] = ->(url) do
92 return if url.include?('_') || url.include?('?')105 return if url.include?('_') || url.include?('?')
@@ -99,6 +112,11 @@ module Docs · 6 unmodified lines
99 url.sub! "#{Dom.base_url}/notification", "#{Dom.base_url}/Notification"112 url.sub! "#{Dom.base_url}/notification", "#{Dom.base_url}/Notification"
100 url.sub! "#{Dom.base_url}/range", "#{Dom.base_url}/Range"113 url.sub! "#{Dom.base_url}/range", "#{Dom.base_url}/Range"
101 url.sub! "#{Dom.base_url}/Window", "#{Dom.base_url}/window"114 url.sub! "#{Dom.base_url}/Window", "#{Dom.base_url}/window"
115 url.sub! "#{Dom.base_url}/window.navigator", "#{Dom.base_url}/navigator"
116 url.sub! "#{Dom.base_url}/Selection/", "#{Dom.base_url}/Selection."
117 url.sub! "#{Dom.base_url}/windowTimers", "#{Dom.base_url}/window"
118 url.sub! "#{Dom.base_url}/windowEventHandlers", "#{Dom.base_url}/window"
119 url.sub! "#{Dom.base_url}/Screen.", "#{Dom.base_url}/window.screen"
102 url120 url
103 end121 end
104 end122 end