Skip to content

fix: include CF4 in list of automatically subscripted chemicals #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrispcampbell merged 3 commits into from
Jun 8, 2023
Merged

fix: include CF4 in list of automatically subscripted chemicals #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22e082e
fix: include CF4 in list of automatically subscripted chemicals
chrispcampbell Jun 8, 2023
8c7b704
fix: include CF4 in regex
chrispcampbell Jun 8, 2023
062b2d6
fix: add auto-subscript example
chrispcampbell Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions examples/sample-docs/projects/sample-guide/content/appendix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
This is the appendix. The text is pink because of a project- and page-specific CSS override.

(This is an example of a page that is only in English and not made available for translation.)

The following chemical formulas should be subscripted automatically:
* CO2
* CF4
* CH4
* N2O
* NF3
* SF6
6 changes: 4 additions & 2 deletions packages/docs-builder/src/gen-html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,7 @@ export function writeErrorHtmlFile(context: Context, mdRelPath: string, error: E

const subscriptMap = new Map([
['CO2', 'CO<sub>2</sub>'],
['CF4', 'CF<sub>4</sub>'],
['CH4', 'CH<sub>4</sub>'],
['N2O', 'N<sub>2</sub>O'],
['NF3', 'NF<sub>3</sub>'],
Expand All @@ -556,8 +557,9 @@ const subscriptMap = new Map([
/**
* Replace non-subscript forms of common chemicals with their subscripted equivalent.
* For example, "CO2" will be converted to "CO<sub>2</sub>". This only handles
* the following common forms:
* the following common forms (defined in the map above):
* CO2
* CF4
* CH4
* N2O
* NF3
Expand All @@ -570,7 +572,7 @@ function subscriptify(s: string): string {
// XXX: Some historical graph images in the En-ROADS User Guide have
// {CO2,CH4,N2O} in the file name, so this regex is set up to avoid
// converting those filenames
return s.replace(/(Hist_)?(CO2|CH4|N2O|NF3|SF6)/g, (m, m1, m2) => {
return s.replace(/(Hist_)?(CO2|CF4|CH4|N2O|NF3|SF6)/g, (m, m1, m2) => {
if (m1) {
return m
} else {
Expand Down