Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert web/api/document to markdown for es #8670

Merged

Conversation

jakul
Copy link
Contributor

@jakul jakul commented Sep 20, 2022

I applied some content fixes to the HTML files pre-conversion and some more to the markdown files post-conversion.

Fixes #8664.

Craig Blaszczyk added 3 commits September 20, 2022 14:37
* remove unneeded brush class
* replace syntaxbox class with js
* add missing classes to pre blocks
* minor content edits
* remove unused languages macro
* add missing ApiRef() block
* replace manual "specifications" and "compat" sections with macros
* minor text improvements
* add missing language indicators to code blocks
* replace http links to W3C with https links
@jakul jakul requested a review from a team as a code owner September 20, 2022 17:44
@jakul jakul requested review from Graywolf9 and removed request for a team September 20, 2022 17:44
@github-actions github-actions bot added the l10n-es Issues related to Spanish content. label Sep 20, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 20, 2022

Preview URLs

Flaws

Note! 11 documents with no flaws that don't need to be listed. 🎉

URL: /es/docs/Web/API/Document/close
Title: Document.close()
Flaw count: 1

  • broken_links:
    • Can't resolve /en/DOM/document.open

URL: /es/docs/Web/API/Document/execCommand
Title: Document.execCommand()
Flaw count: 5

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /es/docs/Web/API/Document/contentEditable does not exist
  • broken_links:
    • Can't resolve /es/docs/Rich-Text_Editing_in_Mozilla
  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /es/docs/Web/API/Document/querySelector
Title: Document.querySelector()
Flaw count: 4

  • macros:
    • /es/docs/Web/API/Element/querySelectorAll does not exist but fell back to /en-US/docs/Web/API/Element/querySelectorAll
  • broken_links:
    • Can't resolve /es/docs/DOM/element
    • Can use the English (en-US) link as a fallback
    • Can't resolve /es/docs/Code_snippets/QuerySelector

URL: /es/docs/Web/API/Document/getElementById
Title: document.getElementById
Flaw count: 7

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can't resolve /es/docs/XHTML
    • Can't resolve /es/docs/Mozilla/Tech/XUL
    • Can't resolve /es/docs/DOM/document
    • Can use the English (en-US) link as a fallback
    • and 1 more flaws omitted
  • translation_differences:
    • Differences in the important macros (3 in common of 5 possible)

URL: /es/docs/Web/API/Document/getElementsByName
Title: Document.getElementsByName()
Flaw count: 2

  • macros:
    • /es/docs/Web/API/Element/name does not exist but fell back to /en-US/docs/Web/API
  • broken_links:
    • Can use the English (en-US) link as a fallback

URL: /es/docs/Web/API/Document/cookie
Title: document.cookie
Flaw count: 8

  • macros:
    • This macro has been deprecated, and should be removed.
  • broken_links:
    • Can't resolve /es/docs/DOM/document.cookie$edit#Using_relative_URLs_in_the_path_parameter
    • Can't resolve /es/Referencia_de_JavaScript_1.5/Funciones_globales/encodeURIComponent
    • Can't resolve /en/HTML/Element/iframe
    • Can't resolve /en/Same_origin_policy_for_JavaScript
    • Can't resolve /es/DOM/Storage
    • and 1 more flaws omitted
  • translation_differences:
    • Differences in the important macros (3 in common of 12 possible)

URL: /es/docs/Web/API/Document/documentElement
Title: document.documentElement
Flaw count: 1

  • macros:
    • /es/docs/Web/API/Document/firstChild does not exist

URL: /es/docs/Web/API/Document/characterSet
Title: document.characterSet
Flaw count: 1

  • broken_links:
    • Is currently http:// but can become https://

URL: /es/docs/Web/API/Document/exitFullscreen
Title: Document.exitFullscreen()
Flaw count: 4

  • macros:
    • This macro has been deprecated, and should be removed.
    • /es/docs/Glossary/user_agent does not exist but fell back to /en-US/docs/Glossary/User_agent
    • /es/docs/Web/API/Document/fullscreenElement does not exist but fell back to /en-US/docs/Web/API/Document/fullscreenElement
  • broken_links:
    • Can use the English (en-US) link as a fallback

URL: /es/docs/Web/API/Document/importNode
Title: Document.importNode()
Flaw count: 5

  • macros:
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
  • broken_links:
    • Can't resolve /en-US/docs/DOM/Node.parentNode
    • Link points to the page it's already on

URL: /es/docs/Web/API/Document/write
Title: Document.write()
Flaw count: 9

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can't resolve /es/docs/Archive/Web/Writing_JavaScript_for_HTML
    • and 3 more flaws omitted
  • translation_differences:
    • Differences in the important macros (3 in common of 4 possible)

URL: /es/docs/Web/API/Document/URL
Title: document.URL
Flaw count: 2

  • macros:
    • /es/docs/Web/API/HTMLDocument does not exist but fell back to /en-US/docs/Web/API/HTMLDocument
  • translation_differences:
    • Differences in the important macros (3 in common of 5 possible)

URL: /es/docs/Web/API/Document/open
Title: Document.open()
Flaw count: 3

  • broken_links:
    • Can't resolve /docs/Security_check_basics
    • Can't resolve /en/wrappedJSObject
    • Can't resolve /en/Security_check_basics

URL: /es/docs/Web/API/Document/dir
Title: Document.dir
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /es/docs/Web/API/Document/bgColor
Title: document.bgColor
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (2 in common of 3 possible)

URL: /es/docs/Web/API/Document/scripts
Title: Document.scripts
Flaw count: 2

  • macros:
    • /es/docs/Web/HTML/Element/script does not exist but fell back to /en-US/docs/Web/HTML/Element/script
    • /es/docs/Web/HTML/Element/script does not exist but fell back to /en-US/docs/Web/HTML/Element/script

URL: /es/docs/Web/API/Document/head
Title: Document.head
Flaw count: 1

  • broken_links:
    • Can use the English (en-US) link as a fallback

URL: /es/docs/Web/API/Document/designMode
Title: Document.designMode
Flaw count: 1

  • broken_links:
    • Can't resolve /es/docs/Rich-Text_Editing_in_Mozilla

URL: /es/docs/Web/API/Document/doctype
Title: Document.doctype
Flaw count: 2

  • macros:
    • /es/docs/Web/API/DocumentType does not exist but fell back to /en-US/docs/Web/API/DocumentType
    • /es/docs/Web/API/DOMImplementation/createDocumentType does not exist but fell back to /en-US/docs/Web/API/DOMImplementation/createDocumentType

URL: /es/docs/Web/API/Document/createDocumentFragment
Title: Document.createDocumentFragment()
Flaw count: 6

  • macros:
    • /es/docs/Web/API/DOMImplementation/createDocument does not exist but fell back to /en-US/docs/Web/API/DOMImplementation/createDocument
  • broken_links:
    • Can't resolve /en-US/docs/DOM/DocumentFragment
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Is currently http:// but can become https://
  • translation_differences:
    • Differences in the important macros (2 in common of 6 possible)

URL: /es/docs/Web/API/Document/createElementNS
Title: Document.createElementNS()
Flaw count: 6

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • No need for the pathname in anchor links if it's the same page
    • Can't resolve /es/docs/DOM/element.nodeName
    • Can't resolve https://developer.mozilla.org/en-US/docs/Web/API/Element
    • Can't resolve /es/docs/XHTML
    • and 1 more flaws omitted

URL: /es/docs/Web/API/Document/styleSheets
Title: Document.styleSheets
Flaw count: 4

  • macros:
    • This macro has been deprecated, and should be removed.
  • broken_links:
    • Can't resolve /es/DOM/stylesheet
    • Can't resolve /es/DOM/stylesheet
  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /es/docs/Web/API/Document/hasFocus
Title: element.hasFocus
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (3 in common of 4 possible)

URL: /es/docs/Web/API/Document/getElementsByTagNameNS
Title: document.getElementsByTagNameNS
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /es/docs/Web/API/Document/readyState
Title: Document.readyState
Flaw count: 7

  • macros:
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
    • This macro has been deprecated, and should be removed.
    • and 2 more flaws omitted

URL: /es/docs/Web/API/Document/documentURI
Title: Document.documentURI
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (3 in common of 4 possible)

URL: /es/docs/Web/API/Document/createElement
Title: Document.createElement()
Flaw count: 3

  • macros:
    • /es/docs/Web/API/HTMLUnknownElement does not exist but fell back to /en-US/docs/Web/API/HTMLUnknownElement
  • broken_links:
    • Can't resolve /es/docs/Mozilla/Tech/XUL
  • translation_differences:
    • Differences in the important macros (3 in common of 5 possible)

URL: /es/docs/Web/API/Document/alinkColor
Title: document.alinkColor
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (2 in common of 3 possible)

URL: /es/docs/Web/API/Document/registerElement
Title: Document.registerElement()
Flaw count: 4

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Anchor not lowercase
    • Can use the English (en-US) link as a fallback
  • translation_differences:
    • Differences in the important macros (2 in common of 3 possible)

URL: /es/docs/Web/API/Document/getElementsByClassName
Title: Document.getElementsByClassName()
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (3 in common of 4 possible)

URL: /es/docs/Web/API/Document/defaultView
Title: Document.defaultView
Flaw count: 2

  • broken_links:
    • Can't resolve /es/docs/DOM/window
    • Is currently http:// but can become https://

URL: /es/docs/Web/API/Document/createRange
Title: document.createRange
Flaw count: 2

  • broken_links:
    • Can't resolve https://developer.mozilla.org/es/docs/Web/API/Range
  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

URL: /es/docs/Web/API/Document/querySelectorAll
Title: Document.querySelectorAll()
Flaw count: 14

  • macros:
    • /es/docs/Web/API/ParentNode/querySelectorAll does not exist
    • /es/docs/Web/API/ParentNode does not exist
    • wrong xref macro used (consider changing which macro you use)
    • /es/docs/Web/API/Div does not exist
    • /es/docs/Web/API/Iframe does not exist
    • and 6 more flaws omitted
  • broken_links:
    • Can't resolve /es/docs/Web/CSS/Selectores_atributo
    • Can't resolve /es/docs/Learn/CSS/Introduction_to_CSS/Selectores_de_Atributos
    • Can't resolve /es/docs/Code_snippets/QuerySelector

URL: /es/docs/Web/API/Document/pointerLockElement
Title: Document.pointerLockElement
Flaw count: 3

  • macros:
    • /es/docs/Web/API/Document/exitPointerLock does not exist but fell back to /en-US/docs/Web/API/Document/exitPointerLock
    • /es/docs/Web/API/Element/requestPointerLock does not exist but fell back to /en-US/docs/Web/API/Element/requestPointerLock
  • broken_links:
    • Can't resolve /es/docs/WebAPI/Pointer_Lock

URL: /es/docs/Web/API/Document/writeln
Title: Document.writeln()
Flaw count: 6

  • broken_links:
    • Can use the English (en-US) link as a fallback
    • Can't resolve /es/DOM/document.write
    • Can't resolve /es/docs/Archive/Web/Writing_JavaScript_for_HTML
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • and 1 more flaws omitted

URL: /es/docs/Web/API/Document/scroll_event
Title: scroll
Flaw count: 7

  • broken_links:
    • Can't resolve /es/docs/Web/API/DOMString
    • Can use the English (en-US) link as a fallback
    • Can use the English (en-US) link as a fallback
    • Can't resolve /es/docs/Web/API/WindowProxy
    • Can't resolve /es/docs/DOM/window.requestAnimationFrame
    • and 2 more flaws omitted

URL: /es/docs/Web/API/Document/createTextNode
Title: Document.createTextNode()
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (3 in common of 4 possible)

URL: /es/docs/Web/API/Document/contentType
Title: Document.contentType
Flaw count: 1

  • translation_differences:
    • Differences in the important macros (2 in common of 4 possible)

External URLs

URL: /es/docs/Web/API/Document/execCommand
Title: Document.execCommand()


URL: /es/docs/Web/API/Document/querySelector
Title: Document.querySelector()


URL: /es/docs/Web/API/Document/cookie
Title: document.cookie


URL: /es/docs/Web/API/Document/anchors
Title: document.anchors


URL: /es/docs/Web/API/Document/importNode
Title: Document.importNode()


URL: /es/docs/Web/API/Document/write
Title: Document.write()


URL: /es/docs/Web/API/Document/dir
Title: Document.dir


URL: /es/docs/Web/API/Document/bgColor
Title: document.bgColor


URL: /es/docs/Web/API/Document/designMode
Title: Document.designMode


URL: /es/docs/Web/API/Document/createDocumentFragment
Title: Document.createDocumentFragment()


URL: /es/docs/Web/API/Document/createElementNS
Title: Document.createElementNS()


URL: /es/docs/Web/API/Document/styleSheets
Title: Document.styleSheets


URL: /es/docs/Web/API/Document/adoptNode
Title: Document.adoptNode()


URL: /es/docs/Web/API/Document/createElement
Title: Document.createElement()


URL: /es/docs/Web/API/Document/alinkColor
Title: document.alinkColor


URL: /es/docs/Web/API/Document/writeln
Title: Document.writeln()

(this comment was updated 2022-09-20 21:38:54.139934)

Copy link
Contributor

@Graywolf9 Graywolf9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, thank you so much for your time and contribution. I have some notes:

  • In the es localization we have some Convention on translations and one of them are "Compatibilidad con navegadores" for that section es guide notes
  • the indentation for all cases is 2 spaces as in the contribution code guidelines
  • finally, I notice that some lists items have not the correct line breaks

Also, there are our chats:

@Graywolf9 Graywolf9 merged commit 89fc5a4 into mdn:main Sep 20, 2022
@jakul jakul deleted the 8664-convert-web-api-document-to-markdown-for-es branch September 21, 2022 10:41
@jakul
Copy link
Contributor Author

jakul commented Sep 21, 2022

Great job, thank you so much for your time and contribution. I have some notes:

  • In the es localization we have some Convention on translations and one of them are "Compatibilidad con navegadores" for that section es guide notes
  • the indentation for all cases is 2 spaces as in the contribution code guidelines
  • finally, I notice that some lists items have not the correct line breaks

Also, there are our chats:

Thanks for this, I was a bit unsure where to get guidance. I'll have a read through before I do the next batch of files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
l10n-es Issues related to Spanish content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: convert web/api/document for Spanish (es) to Markdown
2 participants