HTML is a standard markup language designed for creating web pages. The initial HTML 1 was released in 1991 and the most current version is HTML 5.
HTML has a pre-defined set of tags, which means you cannot create your own tags.
You can embed script languages such as JavaScript (including JSON, more on JSON later) in HTML to add functionality to a web page.
XML is an extendable markup language designed with data exchange in mind. The initial release was in 1996. The latest version is still XML version 1.0.
XML tags are user-defined and each XML file needs its own DTD or schema to validate against. DTD or schema defines the data structure that is permitted for a particular XML file. (The difference between DTD and schema is out of the scope of this discussion.)
XML is not a replacement of HTML nor a rival. The rivals of XML are relational databases and JSON.
XHTML is an XML-ized HTML that complies with both HTML and XML standards. XHTML was initially released in 2000. The latest version is XHTML 5, which adopts HTML5 standards.
XHTML is considered better than HTML because it is in essence an XML format, which means it is more extensible and interoperable with other data formats.
XHTML can be a candidate to replace HTML. However as of today lots of people still believe HTML5 is for the masses and XHTML5 is not.
There are tools available to convert HTML to XHTML. An example is html2xhtml.
JSON is a lightweight data interchange format widely used on the web. JSON is part of Javascript. Because Javascript is a scripting language that can be embedded within HTML, you can directly use JSON in an HTML page. JSON was invented in 2002.
JSON denotes data objects in key-value pairs and is gaining wide adoption because it is much simpler than XML and faster for parsing. JSON is a data-only format and does not permit adding comments in it.
JSON is also a popular format for DevOp configurations.
YAML stands for Yet Another Markup Language. YAML is a data serialization language and it is more human readable than XML and JSON. YML allows you to put comments in it. YML is widely used in pipeline and workflow configurations such as in GitLab CI configurations.
Markdown is a lightweight markup language that was started in 2004. Markdown has simpler syntax rules than HTML and is becoming popular recently because Github and other leading companies support it. Markdown can be easily converted to HTML by a parser for web display.
The drawback of Markdown is their syntax is minimum, which means you only have a subset of what’s available in HTML to work with in Markdown.
There are tools to convert between HTML and Markdown. An example is pandoc.
So what are the main differences and similarities among the above formats?
All the formats are human readable and can be hand-crafted using a text editor such as Notepad++.
HTML, XHTML, and Markdown are markup languages and they are used with the intention to be presented on the web. In other words, the target “consumer” of these markup languages is a web browser. Markdown is the lightweight version, HTML is the standard version, and XHTML is the XML-ized version of HTML.
XML and JSON are data exchange formats. The main “consumers” of XML and JSON are Application Programming Interfaces (API). For example, when you use Google’s popular geocoding API to retrieve info about an address’s geographic coordinates, you are working with JSON data or XML data.
YML is widely used for pipeline configurations and static site generator configurations.
I asked ChatGPT 4 to write this blog for me.
Write a blog post as a senior technical writer with 15 years experience on HTML, XML, XHTML, JSON, YML, and Markdown.
My Journey as a Senior Technical Writer: 15 Years of Markup Language Mastery
Hello, fellow tech enthusiasts! Today, I want to share my journey as a senior technical writer with a focus on my experience with markup languages like HTML, XML, XHTML, JSON, YML, and Markdown. Over the past 15 years, I have seen the evolution of these languages and how they have shaped the way we create, store, and share information on the internet. So, let’s dive into the world of markup languages and discover how they have impacted my career as a technical writer.
When I started my career as a technical writer back in 2008, HTML (HyperText Markup Language) was the primary language used for creating web pages. I still remember the excitement of writing my first HTML document with simple tags like <head>, <body>, <h1>, and <p>. HTML opened up a world of possibilities, allowing writers to structure content and create interactive web pages.
Over the years, I have seen HTML evolve with new elements, attributes, and capabilities. The current version, HTML5, has brought significant improvements in multimedia, semantic elements, and APIs. The continuous development of HTML showcases the importance of this markup language in the digital world.
In the early 2000s, XML (eXtensible Markup Language) emerged as a simple, flexible, and powerful way to structure data. As a technical writer, I quickly recognized the value of XML for creating well-organized and easily maintainable content.
Around the same time, XHTML (eXtensible HyperText Markup Language) was introduced as a stricter, XML-based version of HTML. Although XHTML has been largely replaced by HTML5, I found it valuable for learning the importance of well-formed markup and following coding standards.
As web development progressed, JSON (JavaScript Object Notation) became an increasingly popular data interchange format. JSON’s lightweight and human-readable nature made it easier for me to work with APIs and exchange data between clients and servers.
Today, JSON is widely used across various applications, from web services to configuration files. As a technical writer, mastering JSON has empowered me to write clear, concise documentation for RESTful APIs and other JSON-based technologies.
YML (also known as YAML, which stands for “YAML Ain’t Markup Language”) is a human-friendly data serialization format that has gained popularity for its simplicity and readability. I have found YML particularly useful for writing configuration files and managing data in projects that involve multiple programming languages.
As a technical writer, YML has allowed me to write code snippets and examples that are easy to understand, making my documentation more accessible to a broader audience.
Markdown, a lightweight markup language, has been a game-changer for me as a technical writer. Its simple syntax allows me to focus on writing without being bogged down by complex formatting. I can easily convert Markdown documents into HTML or other formats with the help of various tools.
Markdown has made content creation more efficient, enabling me to write documentation, blog posts, and even this article effortlessly.
As a senior technical writer with 15 years of experience, I have witnessed the evolution and impact of markup languages like HTML, XML, XHTML, JSON, YML, and Markdown. These languages have not only shaped the way we create, store, and share information on the internet, but they have also influenced my approach to technical writing.
I hope that my journey has provided you with valuable insights into the world of markup languages and perhaps inspired you to explore these powerful tools further, whether you are a seasoned technical writer or just embarking on your own journey.
I asked the same prompt to ChatGPT 3.5 (free version) to write this blog for me
As a senior technical writer with 15 years of experience, I have worked extensively with various markup languages including HTML, XML, XHTML, JSON, YML, and Markdown. These languages are critical in the field of technical writing and are used to create and publish documentation for software, hardware, and other technical products.
HTML or Hypertext Markup Language is the foundation of the web and is used to create web pages. It is a markup language that uses tags to define the structure and content of a web page. As a technical writer, I have used HTML extensively to create web-based documentation, user guides, and online help systems.
XML or Extensible Markup Language is a versatile markup language used for data exchange and storage. It is used to create documents that can be easily processed by machines, making it a popular choice for technical documentation. I have used XML to create documentation for software applications, APIs, and other technical products.
XHTML or Extensible Hypertext Markup Language is a reformulation of HTML in XML syntax. It is used to create web pages that conform to XML syntax and is popular in the field of technical writing. I have used XHTML to create web-based documentation and online help systems.
JSON or JavaScript Object Notation is a lightweight format used to exchange data between different systems. It is used extensively in web development and is gaining popularity in the field of technical writing. I have used JSON to create API documentation and other technical documents that require data exchange.
YML or YAML Ain’t Markup Language is a human-readable data serialization format. It is used to store data in a structured format and is popular in the field of technical writing. I have used YML to create configuration files, documentation for software applications, and other technical products.
Markdown is a lightweight markup language used to create formatted text using a plain text editor. It is popular among technical writers for creating documentation that can be easily converted to HTML or other formats. I have used Markdown to create documentation for software applications, APIs, and other technical products.
In conclusion, as a senior technical writer with 15 years of experience, I have worked extensively with HTML, XML, XHTML, JSON, YML, and Markdown. These languages are critical in the field of technical writing and are used to create and publish documentation for software, hardware, and other technical products. As a technical writer, it is essential to stay up to date with the latest technologies and tools to create effective documentation that meets the needs of users.
