From fd2a499a824f2b79b3db5729d232d8b019780dec Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 24 Nov 2024 08:18:43 -0800 Subject: [PATCH 1/3] Add alt text to images and indent ..image directives to fix ordered list items. --- .../choosing_program_lang/choosing-program-lang.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst index b4a76522..37ddda8c 100644 --- a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst +++ b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst @@ -1,7 +1,7 @@ Choosing a Programming Tool ============================ You will need to select a programming tool to be able to write op modes -for your competition robot. FIRST strongly recommends that *all users* +for your competition robot. *FIRST* strongly recommends that *all users* begin by learning how to use the :ref:`Blocks programming tool `. @@ -14,7 +14,8 @@ teams to use: who prefer to design their op modes visually, using a drag-and-drop interface. -.. image:: images/BlocksPicture1.jpg + .. image:: images/BlocksPicture1.jpg + :alt: Screenshot of the Blocks Programming Tool showing a graphical Blocks program. 2. **The OnBot Java Programming Tool** - A text-based programming tool that lets programmers use a web browser to create, edit and save @@ -22,7 +23,8 @@ teams to use: have basic to advanced Java skills and who would like to write text-based op modes. -.. image:: images/onBotJavaScreen.jpg + .. image:: images/onBotJavaScreen.jpg + :alt: Screenshot of the OnBot Java Programming Tool showing some Java source code. 3. **Android Studio** - An advanced integrated development environment for creating Android apps. This tool is the same tool that @@ -30,7 +32,8 @@ teams to use: recommended for advanced users who have extensive Java programming experience. -.. image:: images/androidStudioScreen.jpg + .. image:: images/androidStudioScreen.jpg + :alt: Screenshot of Android Studio showing some Java source code. Each tool has its own merits and weaknesses. For many users (especially rookies and novice programmers), **the Blocks Programming Tool is @@ -43,6 +46,7 @@ Tool. However, OnBot Java is a text-based tool and it requires that the user have a sound understanding of the Java programming language. .. image:: images/ipadPhoneChromebook.jpg + :alt: A tablet, a phone, and a laptop each showing the programming tools in use. It is important to note that with the Blocks Programming Tool and the OnBot Java Programming Tool, a user only needs a web browser to create, From 0c6b4a07ca6272b41511f4ecef630a8126c4f3e1 Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 27 Nov 2024 14:59:29 -0800 Subject: [PATCH 2/3] change ..image to ..figure, adjust image sizes for PDF presentation. --- .../choosing-program-lang.rst | 87 ++++++++++++------- 1 file changed, 58 insertions(+), 29 deletions(-) diff --git a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst index 37ddda8c..0e140398 100644 --- a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst +++ b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst @@ -1,39 +1,63 @@ Choosing a Programming Tool ============================ -You will need to select a programming tool to be able to write op modes -for your competition robot. *FIRST* strongly recommends that *all users* + +You need to select a programming tool to be able to create op modes +for your competition robot. +An Op Mode or Operational Mode is program that tells the robot what to do. +There are three programming tools that are available for you to use. + +*FIRST* strongly recommends that **all users** begin by learning how to use the :ref:`Blocks programming tool `. -There are currently three programming tools that are available for the -teams to use: +The Blocks Programming Tool +--------------------------- + +A visual programming tool that +lets programmers use a web browser to create, edit and save their op +modes. This tool is recommended for novice programmers and for users +who prefer to design their op modes visually, using a drag-and-drop +interface. -1. **The Blocks Programming Tool** - A visual, programming tool that - lets programmers use a web browser to create, edit and save their op - modes. This tool is recommended for novice programmers and for users - who prefer to design their op modes visually, using a drag-and-drop - interface. +.. figure:: images/BlocksPicture1.jpg + :alt: + :width: 75% + :class: no-scaled-link + + Blocks Programming Tool showing a graphical Blocks program. - .. image:: images/BlocksPicture1.jpg - :alt: Screenshot of the Blocks Programming Tool showing a graphical Blocks program. +The OnBot Java Programming Tool +------------------------------- +A text-based programming +tool that lets programmers use a web browser to create, edit and save +their Java op modes. This tool is recommended for programmers who +have basic to advanced Java skills and who would like to write +text-based op modes. -2. **The OnBot Java Programming Tool** - A text-based programming - tool that lets programmers use a web browser to create, edit and save - their Java op modes. This tool is recommended for programmers who - have basic to advanced Java skills and who would like to write - text-based op modes. +.. figure:: images/onBotJavaScreen.jpg + :alt: + :width: 75% + :class: no-scaled-link + + OnBot Java Programming Tool showing Java source code. - .. image:: images/onBotJavaScreen.jpg - :alt: Screenshot of the OnBot Java Programming Tool showing some Java source code. +Android Studio +-------------- +An advanced integrated development environment +for creating Android apps. This tool is the same tool that +professional Android app developers use. Android Studio is only +recommended for advanced users who have extensive Java programming +experience. -3. **Android Studio** - An advanced integrated development environment - for creating Android apps. This tool is the same tool that - professional Android app developers use. Android Studio is only - recommended for advanced users who have extensive Java programming - experience. +.. figure:: images/androidStudioScreen.jpg + :alt: + :width: 50% + :class: no-scaled-link + + Android Studio showing Java source code. - .. image:: images/androidStudioScreen.jpg - :alt: Screenshot of Android Studio showing some Java source code. +Recommendations +--------------- Each tool has its own merits and weaknesses. For many users (especially rookies and novice programmers), **the Blocks Programming Tool is @@ -45,8 +69,12 @@ The OnBot Java Programming Tool is similar to the Blocks Programming Tool. However, OnBot Java is a text-based tool and it requires that the user have a sound understanding of the Java programming language. -.. image:: images/ipadPhoneChromebook.jpg - :alt: A tablet, a phone, and a laptop each showing the programming tools in use. +.. figure:: images/ipadPhoneChromebook.jpg + :alt: + :width: 50% + :class: no-scaled-link + + A tablet, phone, and laptop each showing the programming tools in use. It is important to note that with the Blocks Programming Tool and the OnBot Java Programming Tool, a user only needs a web browser to create, @@ -57,6 +85,7 @@ Android Studio is a powerful development tool. However, it requires extensive Java programming knowledge. It also needs a dedicated laptop to run the Android Studio software. Android Studio offers enhanced editing and debugging features that are not available on the OnBot Java -Programming Tool. However, it is a more complicated tool and is only -recommended for advanced users. +Programming Tool. However, it is a more complicated tool and you must +spend time learning how to use it. +It is only recommended for advanced users. From ad3fe855f30b080d43fb4b823213f43b29f4206d Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 1 Dec 2024 16:57:05 -0800 Subject: [PATCH 3/3] Revert figure to image, add alt text. No caption required IMO. --- .../choosing-program-lang.rst | 32 +++++-------------- 1 file changed, 8 insertions(+), 24 deletions(-) diff --git a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst index 0e140398..ab1031e5 100644 --- a/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst +++ b/docs/source/programming_resources/shared/choosing_program_lang/choosing-program-lang.rst @@ -19,12 +19,8 @@ modes. This tool is recommended for novice programmers and for users who prefer to design their op modes visually, using a drag-and-drop interface. -.. figure:: images/BlocksPicture1.jpg - :alt: - :width: 75% - :class: no-scaled-link - - Blocks Programming Tool showing a graphical Blocks program. +.. image:: images/BlocksPicture1.jpg + :alt: Blocks Programming Tool showing a graphical Blocks program The OnBot Java Programming Tool ------------------------------- @@ -34,12 +30,8 @@ their Java op modes. This tool is recommended for programmers who have basic to advanced Java skills and who would like to write text-based op modes. -.. figure:: images/onBotJavaScreen.jpg - :alt: - :width: 75% - :class: no-scaled-link - - OnBot Java Programming Tool showing Java source code. +.. image:: images/onBotJavaScreen.jpg + :alt: OnBot Java Programming Tool showing Java source code Android Studio -------------- @@ -49,12 +41,8 @@ professional Android app developers use. Android Studio is only recommended for advanced users who have extensive Java programming experience. -.. figure:: images/androidStudioScreen.jpg - :alt: - :width: 50% - :class: no-scaled-link - - Android Studio showing Java source code. +.. image:: images/androidStudioScreen.jpg + :alt: Android Studio showing Java source code Recommendations --------------- @@ -69,12 +57,8 @@ The OnBot Java Programming Tool is similar to the Blocks Programming Tool. However, OnBot Java is a text-based tool and it requires that the user have a sound understanding of the Java programming language. -.. figure:: images/ipadPhoneChromebook.jpg - :alt: - :width: 50% - :class: no-scaled-link - - A tablet, phone, and laptop each showing the programming tools in use. +.. image:: images/ipadPhoneChromebook.jpg + :alt: A tablet, a phone, and a laptop each showing the programming tools in use It is important to note that with the Blocks Programming Tool and the OnBot Java Programming Tool, a user only needs a web browser to create,