docs: address review comments

Author: james

docs/language/ql-training-rst/_static-training/slides-semmle-2/static/theme/css/default.css

@@ -119,10 +119,6 @@ slides {
   height: 56.25vw;
   max-height: 100vh;
   max-width: 177.78vh;
-  /*width: 1200px;
-  height: 675px;
-  left: 50%;
-  top: 50%;*/
   bottom: auto;
   right: auto;
   transform: translate(-50%, -50%);
@@ -543,7 +539,9 @@ pre {
   -webkit-box-sizing: border-box;
   box-sizing: border-box;
   overflow: auto;
+  white-space: pre-wrap;
 }
+
 /* line 351, ../scss/default.scss */
 pre[data-lang]:after {
   content: attr(data-lang);
@@ -1394,7 +1392,9 @@ aside.gdbar img {
   display: none;
 }
 
-/* James rst markup */
+/****** Semmle-specific styles *********/
+
+/* rst markup */
 strong {
   font-weight: bold;
 }
@@ -1408,73 +1408,43 @@ sup {
   font-size: 0.5em;
 }
 
-
-/* James slide backgrounds */
-
-.title-slide {
-  background-image: url("../../title-slide.svg");
-  background-size: cover;
-}
-
+/*custom slide styles */
+/* general */
 slide {
   background-image: url("../../normal-slide.svg");
   background-size: cover;
   width: 100%;
   height: 100%;
   overflow: auto;
   transform: scale(1);
-}   
-
-.end-slide {
-  background-image: url("../../end-slide.svg");
-  background-size: 100% 100%;
-  background-color: #5c31ff;
-} 
+}  
 
-.background2 {  
-  background-image: url("../../alternative-slide.svg");
-  background-size: cover;
+.highlight {
+  width: auto;
+  background: transparent !important;
+  margin-bottom: 2%;
 }
 
-.setup, .agenda {
-  background-image: url("../../setup-slide.svg");
-  background-size: cover;
+p {
+  color: black;
+  font-size: 1em;
 }
 
-.setup article, .agenda article {
+article {
   margin-top: 3%;
-  border-left: 1px  solid #5c31ff;
-  position: absolute;
-  top: 0;
-  bottom: 0;
-  right: 0;
-  left: 0;
-  margin: auto;
-  width: 50%;
-  height: fit-content;
-  padding: 2%;
 }
 
-.setup li {
-  line-height: 1.5em;
-  margin-top: 1.5em;
-}
-
-.agenda li {
-  margin:0;
+hgroup .pre {
+  color: #5c31ff;
 }
 
-.setup ul, .agenda ul {
-  padding: 0;
-}
+/* title slide (deck title, subtitle, semmle logo)*/
 
-.setup hgroup, .agenda hgroup {
-  position: relative;
-  margin: 7% 0 0 17%;
+.title-slide {
+  background-image: url("../../title-slide.svg");
+  background-size: cover;
 }
 
-/*custom slide styles */
-
 .semmle-logo sup {
   vertical-align: super;
   font-size: 0.3em;
@@ -1495,6 +1465,17 @@ slide {
   bottom: 30%;
 }
 
+.title-slide hgroup .pre {
+  color: white;
+}
+
+/* purple background slides (new section)*/
+
+.background2 {  
+  background-image: url("../../alternative-slide.svg");
+  background-size: cover;
+}
+
 .background2 h2 { 
   color: white;
 }
@@ -1504,15 +1485,54 @@ slide {
   font-size: 1.5em;
 }
 
-hgroup .pre {
-  color: #5c31ff;
+/* setup and agenda slides */
+
+.setup, .agenda {
+  background-image: url("../../setup-slide.svg");
+  background-size: cover;
 }
 
-.title-slide hgroup .pre {
-  color: white;
+.setup article, .agenda article {
+  margin-top: 3%;
+  border-left: 1px  solid #5c31ff;
+  position: absolute;
+  top: 0;
+  bottom: 0;
+  right: 0;
+  left: 0;
+  margin: auto;
+  width: 50%;
+  height: fit-content;
+  padding: 2%;
 }
 
-/* James column experiments */
+.setup li {
+  line-height: 1.5em;
+  margin-top: 1.5em;
+}
+
+.agenda li {
+  margin:0;
+}
+
+.setup ul, .agenda ul {
+  padding: 0;
+}
+
+.setup hgroup, .agenda hgroup {
+  position: relative;
+  margin: 7% 0 0 17%;
+}
+
+/* end slide */
+
+.end-slide {
+  background-image: url("../../end-slide.svg");
+  background-size: 100% 100%;
+  background-color: #5c31ff;
+} 
+
+/* styles for side by side columns */
 
 .column-left {
   float: left;
@@ -1539,18 +1559,7 @@ hgroup .pre {
   max-width: 100%;
 }
 
-.highlight {
-  width: auto;
-  background: transparent !important;
-  margin-bottom: 2%;
-}
-
-p {
-  color: black;
-  font-size: 1em;
-}
-
-/* James admonition changes */
+/* admonition (speaker notes) styles */
 
 p.first.admonition-title {
   display: none;
@@ -1584,12 +1593,34 @@ p.first.admonition-title {
   width: inherit;
 }
 
-/* more custom styles */
+/* images */
+/* general styles to scale and centre images*/
+
+.image-box {
+  display: grid;
+  height: 100%;
+}
+
+img {
+  width: 50%;
+  margin: auto;
+}
+
+/* deck-specific styles for individual images*/
+/* intro to ql */
+img.analysis {
+  width: 90%;
+}
 
-span.n, span.p {
-  color: grey;
+/* program representation*/
+.ast-graph {
+  width: 66%;
+  position: absolute;
+  right: -10%;
 }
 
+/* custom styles for lists*/
+
 ol {
   color: black;
 }
@@ -1598,21 +1629,25 @@ li > ul > li {
   margin-bottom: 0;
 }
 
-/* scale and centre images*/
+/*
+ * extra styles for more appropriate for syntax highlighting
+ *
+ */
 
-.image-box {
-  display: grid;
-  height: 100%;
-}
+ span.n, span.p, span.o {
+  color: black !important;
+ }
 
-img {
-  max-width: 50%;
-  margin: auto;
-}
+ .highlight { color: #333 !important} /* default */ 
+ .highlight .s { color: #06994a !important} /* strings */
+ .highlight .m { color: #333 } /* numbers (no special highlighting) */
+ .highlight .c1 { color: #007020 !important; font-style: italic !important} /* one-line comments */
+ .highlight .cm { color: #007020 !important; font-style: italic !important} /* multiline comments */
+ .highlight .cp { color: #2F1695 !important; font-style: italic !important} /* QLDoc comments */
+ .highlight .k { color: #7a65cd !important; font-weight: bold !important} /* keywords */
+ .highlight .kt { color: #7a65cd !important; font-weight: bold !important} /* built-in type keywords */
+ .highlight .kr { color: #333 !important; font-style: italic !important} /* annotations */
 
-article {
-  margin-top: 3%;
-}
 
 @media print {
   /* line 978, ../scss/default.scss */
@@ -1716,59 +1751,4 @@ article {
   slides {
     bottom: unset;
   }
-  
-}
-/*
-@media screen and (max-width: 450px) { 
-  slides {
-    font-size: 1.2vmin;
-  }
-}
-
-@media screen and (min-width: 451px) and (max-width: 767px) { 
-  slides {
-    font-size: 2.5vmin;
-  }
-}
-
-@media screen and (min-width: 451px) and (orientation : portrait) { 
-  slides {
-    font-size: 1.2vmin;
-  }
-}
-
-@media screen and (min-width: 768px) and (max-width: 1024px) and (orientation: portrait) { 
-  slides {
-    font-size: 1.2vmin;
-  }
-}
-
-@media screen and (min-width: 768px) and (max-width: 812px) and (orientation: landscape) { 
-  slides {
-    font-size: 2.2vmin;
-  }
-}
-
-
-@media screen and (min-width: 813px) and (max-width: 1024px) and (orientation: landscape) { 
-  slides {
-    font-size: 1.8vmin;
-  }
-}
-
-@media screen and (min-width: 1025px) and (orientation: landscape){
-  slides {
-    font-size: 2vmin;
-  }
-}
-
-@media screen and (min-width: 1025px) and (orientation: portrait){
-  slides {
-    font-size: 1.2vmin;
-  }
-}
-*/
-.wrapper {
-  height: 675px;
-  resize: both;
 }

docs/language/ql-training-rst/cpp/bad-overflow-guard.rst

@@ -2,6 +2,8 @@
 Example: Bad overflow guard
 ===========================
 
+QL for C/C++
+
 .. container:: semmle-logo
 
    Semmle :sup:`TM`

docs/language/ql-training-rst/cpp/control-flow-cpp.rst

@@ -1,6 +1,8 @@
-================================
-Analyzing control flow for C/C++
-================================
+======================
+Analyzing control flow
+======================
+
+QL for C/C++
 
 .. container:: semmle-logo
 

docs/language/ql-training-rst/cpp/data-flow-cpp.rst

@@ -1,13 +1,13 @@
-===================================
-Introduction to data flow for C/C++
-===================================
+=========================
+Introduction to data flow
+=========================
+
+Finding string formatting vulnerabilities in C/C++
 
 .. container:: semmle-logo
 
    Semmle :sup:`TM`
 
-Finding string formatting vulnerabilities in C/C++
-
 .. rst-class:: setup
 
 Setup