Introducing basic structure of upcoming course on Ada idioms

AdaCore · Oct 13, 2023 · 315ab4b · 315ab4b
1 parent 413736b
commit 315ab4b
Show file tree

Hide file tree

Showing 6 changed files with 125 additions and 0 deletions.
diff --git a/content/courses/ada-idioms/chapters/appendices.rst b/content/courses/ada-idioms/chapters/appendices.rst
@@ -0,0 +1,6 @@
+:next_state: False
+
+Appendices
+==========
+
+.. include:: ../../global.txt
diff --git a/content/courses/ada-idioms/chapters/introduction.rst b/content/courses/ada-idioms/chapters/introduction.rst
@@ -0,0 +1,6 @@
+:prev_state: False
+
+.. include:: ../../global.txt
+
+Introduction
+============
diff --git a/content/courses/ada-idioms/conf.ini b/content/courses/ada-idioms/conf.ini
@@ -0,0 +1,4 @@
+[DEFAULT]
+title=Ada Idioms
+author=Patrick Rogers
+
diff --git a/content/courses/ada-idioms/index.rst b/content/courses/ada-idioms/index.rst
@@ -0,0 +1,101 @@
+:prev_state: False
+:next_state: False
+
+.. _Ada_Idioms_Course_Index:
+
+Ada Idioms
+==========
+
+.. include:: ../global.txt
+
+.. only:: builder_epub
+
+    Release |release|
+
+    |today|
+
+.. only:: builder_latex or builder_epub
+
+    .. container:: content-copyright
+
+        Copyright © 2023, AdaCore
+
+        This book is published under a CC BY-SA license, which means that you
+        can copy, redistribute, remix, transform, and build upon the content
+        for any purpose, even commercially, as long as you give appropriate
+        credit, provide a link to the license, and indicate if changes were
+        made. If you remix, transform, or build upon the material, you must
+        distribute your contributions under the same license as the original.
+        You can find license details
+        `on this page <http://creativecommons.org/licenses/by-sa/4.0>`_
+
+        .. image:: ../../images/ccheart_black.png
+            :width: 108pt
+
+.. container:: content-description
+
+    This course will teach you the basics of the Ada programming language and
+    is intended for those who already have a basic understanding of programming
+    techniques. You will learn how to apply those techniques to programming in
+    Ada.
+
+    This document was written by Patrick Rogers.
+
+    .. note::
+
+        The code examples in this course use an 80-column limit, which is a
+        typical limit for Ada code. Note that, on devices with a small screen
+        size, some code examples might be difficult to read.
+
+    .. only:: builder_latex or builder_epub
+
+        .. note::
+
+            Each code example from this book has an associated "code block
+            metadata", which contains the name of the "project" and an MD5 hash
+            value. This information is used to identify a single code example.
+
+            You can find all code examples in a zip file, which you can
+            `download from the learn website <https://learn.adacore.com/zip/learning-ada_code.zip>`_.
+            The directory structure in the zip file is based on the code block
+            metadata. For example, if you're searching for a code example with
+            this metadata:
+
+            - Project: Courses.Intro_To_Ada.Imperative_Language.Greet
+
+            - MD5: cba89a34b87c9dfa71533d982d05e6ab
+
+            you will find it in this directory:
+
+            :file:`projects/Courses/Intro_To_Ada/Imperative_Language/Greet/cba89a34b87c9dfa71533d982d05e6ab/`
+
+            In order to use this code example, just follow these steps:
+
+            1. Unpack the zip file;
+            2. Go to target directory;
+            3. Start GNAT Studio on this directory;
+            4. Build (or compile) the project;
+            5. Run the application (if a main procedure is available in the
+               project).
+
+
+.. only:: builder_html
+
+    .. container:: ebook-download
+
+        .. raw:: html
+
+            <a class="ebook-download-button" href="/pdf_books/courses/ada-idioms.pdf">
+                Download PDF
+            </a>
+
+            <a class="ebook-download-button" href="/epub_books/courses/ada-idioms.epub">
+                Download EPUB
+            </a>
+
+.. toctree::
+    :maxdepth: 4
+    :caption: Contents:
+
+    Introduction <chapters/introduction>
+    Appendices <chapters/appendices>
diff --git a/content/index.rst b/content/index.rst
@@ -84,6 +84,7 @@
             :maxdepth: 1
             :caption: Upcoming Courses
 
+            Ada Idioms <courses/ada-idioms/index>
             Advanced SPARK <courses/advanced-spark/index>
 
     .. toctree::

diff --git a/frontend/Makefile b/frontend/Makefile
@@ -118,6 +118,13 @@ test_content_courses_advanced-spark:
 	$(eval CONTENT_CHAPTERS := courses/advanced-spark/chapters)
 	$(call test_content,$(MAX_SRC_COLUMNS),$(DIR_LEVELS),$(CONTENT_CHAPTERS))
 
+test_content_courses_ada-idioms:
+	@echo "===== ADA IDIOMS ====="
+	$(eval MAX_SRC_COLUMNS := 80)
+	$(eval DIR_LEVELS := 0)
+	$(eval CONTENT_CHAPTERS := courses/ada-idioms/chapters)
+	$(call test_content,$(MAX_SRC_COLUMNS),$(DIR_LEVELS),$(CONTENT_CHAPTERS))
+
 test_content_courses_whats-new-in-ada-2022:
 	@echo "===== WHAT'S NEW IN ADA 2022 ====="
 	$(eval MAX_SRC_COLUMNS := 80)