You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/docs/about/dev_guide.md
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -217,9 +217,10 @@ A `{ width=80% }` attribute at the end of this string could help in resizing the
217
217
218
218
##### Images generated by LaTeX
219
219
220
+
<!-- TODO: update the following. -->
221
+
220
222
Some images are generated by LaTeX: the `.tex` file is what is used to generate the `.pdf` file, and then pdf2svg converts the `.pdf` into a `.svg` file.
221
223
pdftoppm furthermore convert the `.pdf` into a `.png`.
222
-
<!-- TODO: update the following. -->
223
224
The `.svg` files are used in the `.html`, `.odt` and `.docx` documents, while the `.pdf` is used in the `.pdf` documents.
224
225
The resulting images are added to the repository so that there is no need to re-compile them every time, or to set-up LaTeX and latexmk on each system.
225
226
@@ -258,11 +259,10 @@ Graphs are used to represent binary trees.
258
259
259
260
To create a new class diagram, say for a `BTree_Example`, follow those steps:
260
261
261
-
1. Create a `BTree_Example.txt` file in `source/diag/gra` that follows [the syntax for flowchart diagrams](https://mermaid.js.org/syntax/flowchart.html) (note that there is no need to add `flowchart` at the beginning, it will be done automatically),
262
-
2. Add on the first line a comment `%% title` with "title" the title of the diagram,
263
-
3. Run (from the `source/` folder) `make diag/gra/BTree_Example.md`,
264
-
4. Integrate the resulting drawing, properly captioned and with links to `BTree_Example.txt`, `BTree_Example.svg` and `BTree_Example.png` files using `!include diag/flo/BTree_Example.md`.
265
-
262
+
#. Create a `BTree_Example.txt` file in `source/diag/gra` that follows [the syntax for flowchart diagrams](https://mermaid.js.org/syntax/flowchart.html) (note that there is no need to add `flowchart` at the beginning, it will be done automatically),
263
+
#. Add on the first line a comment `%% title` with "title" the title of the diagram,
264
+
#. Run (from the `source/` folder) `make diag/gra/BTree_Example.md`,
265
+
#. Integrate the resulting drawing, properly captioned and with links to `BTree_Example.txt`, `BTree_Example.svg` and `BTree_Example.png` files using `!include diag/flo/BTree_Example.md`.
266
266
267
267
#### Source code
268
268
@@ -282,9 +282,6 @@ To create a new class diagram, say for a `BTree_Example`, follow those steps:
282
282
Do **not** add solution (`sln`) or project (`csproj`) files: they will be created automatically using the project and solution's name you specified (and a makefile rule [similar to this one](https://github.com/csci-1301/C-Sharp-project-maker)), if multiple classes are present they will all be linked, and the resulting archive will be hosted at `content/code/projects/<solution>.zip`.
283
283
284
284
- Source code that is faulty, partial, or does not terminate can be included in markdown as inline code block.
285
-
<!--
286
-
- We can automatically check these code snippets for syntactical correctness if these guidelines are followed
287
-
-->
288
285
289
286
Code snippets can be included in markdown documents using [pandoc-include](https://github.com/DCsunset/pandoc-include) filter:
0 commit comments