Skip to content

Commit

Permalink
Improved treatment of ⚠ unicode sign.
Browse files Browse the repository at this point in the history
  • Loading branch information
aubertc committed Aug 21, 2024
1 parent 60351ad commit 6154ff7
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 34 deletions.
54 changes: 33 additions & 21 deletions source/docs/about/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,18 +309,6 @@ We will follow the guidance provided [on this page](https://karl-voit.at/2022/01
- Use One Tag Language
- Explain Your Tags


<!--
| Description | Shortcode | Icon |
| : | | |
| Security related aspects will be labelled as "security" | `:shield:` | 🛡 |
| Optional parts will be labelled as "optional" | `:question:` | ❓ |
| Elements to be incorporated in the future as "soon" | `:soon:` | 🔜 |
-->
<!--
| Examples of common pitfalls | `:warning:` | ⚠️ |
-->

## Styling and Templating

Templating files are under `source/templates/` directory.
Expand Down Expand Up @@ -408,7 +396,7 @@ This is needed if running a recent version of pandoc (as of pandoc 3.1.6.1 at le

#### Running the build

| Warning |
| ⚠ Warning |
|:---------------------------|
| Running `make all` can be *very resource-incentive* and may render your system unstable. Read this section entirely before running any command. |

Expand Down Expand Up @@ -479,15 +467,39 @@ A couple of indications about the edits made to quartz:
useSavedState: true, // To debug the explorer, change to "false" (this way, the menu is not cached / permanent),
```
to `false` in the `quartz/components/Explorer.tsx` file *may* help in refreshing the menu more easily.

- Other files edited or created include:
- `quartz/components/AlternativeFormats.tsx` and `quartz/components/styles/alternativeFormats.scss` to list alternative formats at the top of the page,
- `quartz/components/Comments.tsx`, `quartz/components/scripts/darkmode.inline.ts`, `quartz/components/Footer.tsx` and `quartz/components/styles/listPage.scss` to customize the footer and add a link to [our repository feedback](#maintaining-repository-feedback) (while following [the selected style](https://github.com/jackyzha0/quartz/issues/1161)),
- `quartz/styles/base.scss` to load a different set of fonts,
- `quartz/components/Explorer.tsx` and `quartz.layout.ts` to tweak the menu and layout,
- `quartz.config.ts` to set meta-data about the website,
- `quartz/components/pages/404.tsx` to customize the 404 error message,
- `quartz/plugins/emitters/assets.ts` to emit the `.md` files (they are not available by default),
- `quartz/components/index.ts` to tie it all together.
- The files

```text
quartz/components/AlternativeFormats.tsx
quartz/components/styles/alternativeFormats.scss
```

list alternative formats at the top of the page,
- The files

```text
quartz/components/Comments.tsx
quartz/components/scripts/darkmode.inline.ts
quartz/components/Footer.tsx
quartz/components/styles/listPage.scss
```
customize the footer and add a link to [our repository feedback](#maintaining-repository-feedback) (while following [the selected style](https://github.com/jackyzha0/quartz/issues/1161)),
- `quartz/styles/base.scss` loads a different set of fonts,
- The files

```text
quartz/components/Explorer.tsx
quartz.layout.ts
```
tweak the menu and layout,
- `quartz.config.ts` sets meta-data about the website,
- `quartz/components/pages/404.tsx` customizes the 404 error message,
- `quartz/plugins/emitters/assets.ts` emits the `.md` files (they are not available by default),
- `quartz/components/index.ts` ties it all together.

Refer to [Generate the git patch](#generate-the-git-patch) for instruction on how to generate a patch containing all the edits performed to our local copy of quartz.

Expand Down
2 changes: 1 addition & 1 deletion source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ You can either:

Note that on most pages, on the right below the title, there are links to download the current webpage in md, pdf, odt and docx as well as a link to its source code: your [contributions](./docs/about/contributing) will be welcome!

| Warning |
| ⚠ Warning |
|:---------------------------|
| As of early Fall 2024, this resource is under active (re)development. Please, [refer to the CSCI-1301 website](https://csci-1301.github.io/) if you are looking for stable resources on programming for C#. |
8 changes: 4 additions & 4 deletions source/projects/submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ title: How to Submit Projects

First, make sure your name and the date is placed in a delimited comment at the very beginning of each of your `.cs` file.

| Warning |
| ⚠ Warning |
|:---------------------------|
| A *delimited* comment starts with `/*` and ends with `*/`. It must be *on the very first line* in your file, even before `using System;`. |

Once your project is done, [zip the folder](./docs/programming_and_computer_usage/unzipping_archives#zipping-files) into a file `lname_fname`, where `lname` is your last name and `fname` is your first name.
With the file extension, the filename will look like `lname_fname.zip`.

| Warning |
| ⚠ Warning |
|:---------------------------|
| Make sure your file is named "lname_fname.zip" and not "lname_fname.zip.zip". Some operating systems hide the file's extension by default, but you may be able to see it by right-clicking on it and then selecting "Properties" or "Get Info". |

Upload this zip onto D2L / LMS before the deadline in the appropriate assignment submission folder.

| Warning |
| ⚠ Warning |
|:---------------------------|
| Make sure you submitted the correct files, for instance by retracing the steps described in [the Hello World lab](./labs/HelloWorld#how-was-the-backup). |

Expand Down Expand Up @@ -49,7 +49,7 @@ A good, finished project should include *all* of the following:
You can ask the instructor or the (under)graduate course assistants for help and feedback. Please upload your project according to the instructions and send an email asking to go over it if you want us to check that you submitted the correct file, that your code compiles, etc.
You should ask early and not wait until the last minute.

| Warning |
| ⚠ Warning |
|:---------------------------|
| *Do not* ask other classmates for help, copy and paste from the internet, or ask a chatbot to writh the program for you. This work is supposed to be *your own*, and should reflect *your own* understanding. Getting help from un-authorized sources will hurt your understanding of this class and therefore your grade on the long run. |

Expand Down
21 changes: 13 additions & 8 deletions source/templates/pdf/header.tex
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
\newunicodechar{🔒}{\symb 🔒} % U+1F512, "LOCK"
\newunicodechar{✘}{\symb ✘} % U+2718, "HEAVY BALLOT X"
\newunicodechar{✓}{\symb ✓} % U+2713, "CHECK MARK"
\newunicodechar{⚠}{\symb ⚠} % U+26A0, "WARNING SIGN"
\newunicodechar{❓}{\symb ❓} % U+2753, "BLACK QUESTION MARK ORNAMENT"
\newunicodechar{🔜}{\symb 🔜} % U+1F51C, "SOON WITH RIGHTWARDS ARROW ABOVE"
\newunicodechar{ℕ}{\symb ℕ} % U+2115, "DOUBLE-STRUCK CAPITAL N"
Expand All @@ -35,12 +34,18 @@
\newunicodechar{☑}{\symb ☑} % U+2611, "BALLOT BOX WITH CHECK"
\newunicodechar{☐}{\symb ☐} % U+2610, "BALLOT BOX"

% Warning symbol
\newunicodechar{⚠}{\symb ⚠} % U+26A0, "WARNING SIGN"
% Warning, do not use the emoji ⚠️, rendered as the unicode ⚠ sometimes but not compatible with XeTeX.
% An alternative solution could be to define a "custom" warning sign using the following.
% Courtesy of https://tex.stackexchange.com/a/159701
\newcommand\Warning{%
\makebox[1.4em][c]{%
\makebox[0pt][c]{\raisebox{.1em}{\small!}}%
\makebox[0pt][c]{\color{red}\Large$\bigtriangleup$}}}%
\newunicodechar{⚠}{\Warning} % U+26A0
%\newcommand\Warning{%
% \makebox[1.4em][c]{%
% \makebox[0pt][c]{\raisebox{.1em}{\small!}}%
% \makebox[0pt][c]{\color{red}\Large$\bigtriangleup$}}}%
%\newunicodechar{⚠}{\Warning} % U+26A0



% Spaces
\newunicodechar{ }{\symb  }
Expand All @@ -53,8 +58,8 @@

% This character "🛡", apparently also represented with "◌️" and ️" "
% and known as U+FE0F, "VARIATION SELECTOR-16"
% was weirdly added, and tracked in the lecture notes using
% grep "$(printf '\uFE0F')" lectures/*/readme.md
% was weirdly added, and tracked using
% grep "$(printf '\uFE0F')" *.md

% To look for a unicode symbol in the files, we can also use
% grep -r $'\u035F' *
Expand Down

0 comments on commit 6154ff7

Please sign in to comment.