History

Update DOM documentation

Thibaut committed 12 years ago

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

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
1111 'Geolocation' => 'Geolocation',
1212 'Media Capture' => 'Media',
1313 'Media Source' => 'Media',
14+ 'MediaStream' => 'MediaRecorder',
1415 'Navigation Timing' => 'Navigation Timing',
1516 'Network Information' => 'Network Information',
1617 'Web Audio' => 'Web Audio',
17− 'Web Workers' => 'Web Workers' }
18+ 'Web Workers' => 'Web Workers',
19+ 'WebRTC' => 'WebRTC' }
1820
1921 TYPE_BY_NAME_STARTS_WITH = {
22+ 'Audio' => 'Audio',
2023 'Canvas' => 'Canvas',
2124 'ChildNode' => 'Node',
22− 'console' => 'Console',
25+ 'Console' => 'Console',
2326 'CSS' => 'CSS',
2427 'document' => 'Document',
2528 'DocumentFragment' => 'DocumentFragment',
@@ -31,12 +34,14 @@ module Docs · 5 unmodified lines
3134 'GlobalEventHandlers' => 'GlobalEventHandlers',
3235 'history' => 'History',
3336 'IDB' => 'IndexedDB',
37+ 'IndexedDB' => 'IndexedDB',
3438 'Location' => 'Location',
3539 'navigator' => 'Navigator',
3640 'Node' => 'Node',
3741 'Notification' => 'Notification',
3842 'ParentNode' => 'Node',
3943 'Range' => 'Range',
44+ 'RTC' => 'WebRTC',
4045 'Selection' => 'Selection',
4146 'StyleSheet' => 'CSS',
4247 'SVG' => 'SVG',
@@ -104,9 +109,9 @@ module Docs · 61 unmodified lines
104109 end
105110
106111 def include_default_entry?
107− !(node = doc.at_css '.overheadIndicator') ||
108− !node.content.include?('not on a standards track') &&
109− !node.content.include?('removed from the Web')
112+ (node = doc.at_css '.overheadIndicator').nil? ||
113+ type == 'Console' ||
114+ (node.content.exclude?('not on a standards track') && node.content.exclude?('removed from the Web'))
110115 end
111116 end
112117 end
lib/docs/scrapers/mdn/dom.rb+26−8
@@ -10,11 +10,9 @@ module Docs · 9 unmodified lines
1010 # Don't want
1111 options[:skip] = %w(
1212 /App
13− /Apps
1413 /CallEvent
1514 /CanvasPixelArray
1615 /ChromeWorker
17− /ContactManager
1816 /document.createProcessingInstruction
1917 /document.documentURIObject
2018 /document.loadOverlay
@@ -33,9 +31,10 @@ module Docs · 12 unmodified lines
3331 /PowerManager
3432 /PushManager
3533 /ProcessingInstruction
36− /select.type
3734 /TCPServerSocket
3835 /TCPSocket
36+ /TypeInfo
37+ /Web_Video_Text_Tracks_Format
3938 /WifiManager
4039 /window.controllers
4140 /window.crypto
@@ -48,7 +47,6 @@ module Docs · 6 unmodified lines
4847 /window.navigator.requestWakeLock
4948 /window.updateCommands
5049 /window.pkcs11
51− /XMLDocument
5250 /XMLHttpRequest/Using_XMLHttpRequest)
5351
5452 options[:skip_patterns] = [
@@ -57,20 +55,29 @@ module Docs · 2 unmodified lines
5755 /moz/i,
5856 /gecko/i,
5957 /webkit/i,
58+ /gamepad/i,
59+ /UserData/,
6060 /\A\/Camera/,
6161 /\A\/DeviceStorage/,
6262 /\A\/document\.xml/,
63+ /\A\/XMLDocument/,
6364 /\A\/DOMCursor/,
6465 /\A\/DOMRequest/,
6566 /\A\/element\.on/,
6667 /\A\/Entity/,
67− /\A\/HTMLIFrameElement\./,
6868 /\A\/navigator\.id/i,
6969 /\A\/Settings/,
7070 /\A\/Telephony/,
7171 /\A\/Bluetooth/,
72− /UserData/,
73− /\A\/Window\.\w+bar/i]
72+ /\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/]
7481
7582 # Broken / Empty
7683 options[:skip].concat %w(
@@ -86,7 +93,13 @@ module Docs · 9 unmodified lines
8693 /Window.QueryInterface)
8794
8895 # 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)
90103
91104 options[:fix_urls] = ->(url) do
92105 return if url.include?('_') || url.include?('?')
@@ -99,6 +112,11 @@ module Docs · 6 unmodified lines
99112 url.sub! "#{Dom.base_url}/notification", "#{Dom.base_url}/Notification"
100113 url.sub! "#{Dom.base_url}/range", "#{Dom.base_url}/Range"
101114 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"
102120 url
103121 end
104122 end