Add draft plan and Chapter1 draft

1 files changed, 50 insertions, 0 deletions

diff --git a/_chapter1.qmd b/_chapter1.qmd
new file mode 100644
index 0000000..d46eb3c
--- /dev/null
+++ b/_chapter1.qmd
@@ -0,0 +1,50 @@
+Chapter 1

+

+In this chapter we are going to explore the key tools and technologies used in this project. This includes a brief overview of Quarto, Markdown, Lua, other relevant technologies that play a vital role in achieving the project’s goal.

+

+Markdown

+Markdown is a lightweight markup language used to format plain text. It’s designed to be easy to read and write, with a simple syntax that allows writers to format headings, lists, and links. Quarto uses Markdown as its input format to generate richly formatted documents, making it an essential tool in academic and technical publishing. For the purposes of this project, Markdown serves as the foundation for embedding semantic annotations, which will be processed and transformed into different output formats.

+

+Why it’s is useful in academic writing

+Markdown allows writers to focus on content without worrying about formatting, and is ideal for taking notes and structuring thoughts in academic writing.

+

+Usage

+

+

+Quarto

+Quarto is an open-source publishing system that allows users to create dynamic and reproducible documents. It integrates with various formats like HTML, PDF, and slides and uses Markdown as its input format. One of its key features is its extensibility, enabling users to enhance the publishing process by writing plugins and scripts. This project aims to extend Quarto’s capabilities by introducing a custom extension that handles semantic annotations embedded in Markdown files.

+

+Connection to our project

+Quarto is the platform we’’re extending to support semantic annotations. Its DOM-based architecture allows to inject and process metadata during the conversion process. For example, we can write a Lua plugin to detect semantic annotations in Markdown and transform them into structured metadata for HTML or PDF outputs.

+

+

+

+

+

+

+Lua

+Lua is a lightweight, high-performance scripting language widely used in embedded systems, game development, and software extensions. Quarto leverages Lua for writing custom extensions due to its simplicity, efficiency, and small footprint. For this project, Lua will be used to write a plugin that processes semantic annotations in Markdown files and generates appropriate metadata in HTML and PDF outputs. Lua’s versatility makes it ideal for such tasks, allowing for fine-grained control over document processing while maintaining high performance.

+

+Lua is the preferred language for this project because:

+

+It is natively supported by Pandoc and Quarto.

+It is lightweight and fast, making it ideal for document processing.

+Its simplicity allows for rapid development of custom filters and plugins.

+

+

+Semantic Annotations

+Semantic annotations refer to the practice of embedding additional meaning or metadata within a document, allowing for richer data representation and understanding. In the context of Quarto and Markdown, semantic annotations will enable the document to contain extra information (e.g., definitions, references, and classifications) that can be used in various output formats. For example, annotations in Markdown will be transformed into RDFa (for HTML) or XMP metadata (for PDF) to enhance the document’s accessibility and interactivity.Unlike syntactic formatting (e.g., bold or italics), semantic annotations describe the purpose or role of a piece of text. For example, @concept{Artificial Intelligence} indicates that "Artificial Intelligence" is a key concept in the document.

+

+Purpose

+In academic writing, semantic annotations help organize knowledge, improve information retrieval, and enhance storytelling. They allow authors to tag concepts, definitions, and relationships, making it easier to restructure and process content later.

+

+

+Output Formats (HTML and PDF)

+Once the semantic annotations are embedded into the Markdown file, they need to be correctly transformed and rendered in the output formats. Quarto supports generating HTML and PDF outputs. For HTML, semantic annotations will be represented using RDFa, which is a form of structured metadata embedded in HTML content. For PDF, annotations will be encoded as XMP metadata, which allows for the integration of additional information into the PDF document's properties. These transformations will ensure that the enriched content is preserved in both formats.

+

+Other Technologies Involved

+Pandoc, LaTeX,RDFa and XMP Metadata:

+

+

+Conclusion of Chapter 1

+This chapter provided an overview of the key tools and technologies used in this project, including Quarto, Markdown, Lua, and the concepts of semantic annotations. Understanding these tools and their roles in the project is crucial for the successful implementation of the extension that processes semantic annotations in Markdown files. The following chapters will delve deeper into the technical aspects of the implementation and the challenges encountered along the way.