Skip to content
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

Jump to bottom

Fix UG for CS2101 submission #559

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
+22 −15
Open

Fix UG for CS2101 submission #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7878500
Fix broken links
RichDom2185 Nov 10, 2022
cb95a30
Fix spacing to accomodate footnotes
RichDom2185 Nov 10, 2022
4ecfe14
Fix broken links
RichDom2185 Nov 10, 2022
eeb3fc5
Improve glossary multi-column print layout
RichDom2185 Nov 10, 2022
75105ce
Fix extra space
RichDom2185 Nov 10, 2022
729c7c5
Remove extra colons
RichDom2185 Nov 11, 2022
e254679
Merge branch 'master' into week14/fix-ug-for-submission
RichDom2185 Nov 25, 2022
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
2 changes: 1 addition & 1 deletion docs/_glossary/CommandInputBox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ show-in: [ug, dg]

The region located at the top-left of FoodRem's main window.

To view more information, refer to the [Layout](/UserGuide.html#layout) section of the User Guide.
To view more information, refer to the [Layout](#layout) section of the User Guide.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line breaks for the DG, seeing how the pipeline is failing as well. This section is supposed to show in the DG and link to the UG's layout section so just [Layout](#layout) doesn't seem to be working for the DG tho it does fix the broken link for UG.

Alternatively, since the actual link we want is https://ay2223s1-cs2103t-w16-2.github.io/tp/UserGuide.html#layout while the previous link links to https://ay2223s1-cs2103t-w16-2.github.io/UserGuide.html#layout, maybe just adding the missing /tp like [Layout](/tp/UserGuide.html#layout) would suffice.

2 changes: 1 addition & 1 deletion docs/_glossary/CommandOutputBox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ show-in: [ug, dg]

The region located at the right half of FoodRem's main window.

To view more information, refer to the [Layout](/UserGuide.html#layout) section of the User Guide.
To view more information, refer to the [Layout](#layout) section of the User Guide.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

2 changes: 1 addition & 1 deletion docs/_glossary/HelpWindow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ show-in: [ug, dg]

A pop-up window containing help information, shown only after calling a `help` command.

To view more information, refer to the [Layout](/UserGuide.html#layout) section of the User Guide.
To view more information, refer to the [Layout](#layout) section of the User Guide.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, this needs to be fixed, but this is not the fix. The issue is that if we don't use a fragment, this will break the PDF version of the UG since it will try to open a website instead. Working on a fix in the validation.

2 changes: 1 addition & 1 deletion docs/_glossary/ItemListBox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ show-in: [ug, dg]

The region located at the bottom-left of FoodRem's main window.

To view more information, refer to the [Layout](/UserGuide.html#layout) section of the User Guide.
To view more information, refer to the [Layout](#layout) section of the User Guide.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, this needs to be fixed, but this is not the fix. The issue is that if we don't use a fragment, this will break the PDF version of the UG since it will try to open a website instead. Working on a fix in the validation.

2 changes: 1 addition & 1 deletion docs/_sass/foodrem.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ article.post {

@media print {
// Bug in Chrome when having multiple columns for printing
columns: 1;
columns: 2;
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/_ug/Layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- markdownlint-disable-file first-line-h1 -->

<!-- TODO: Update UI Images after UI updates are implemented -->
When you launch FoodRem, FoodRem appears on your screen as a [[ graphical-user-interface:Graphical User Interface ]], or GUI. Let's look at the layout of the different components of FoodRem.
When you launch FoodRem, FoodRem appears on your screen as a [[ graphical-user-interface:Graphical User Interface, ]] or GUI. Let's look at the layout of the different components of FoodRem.

FoodRem's GUI consists of a single main window, as well as the [[ help-window:Help Window ]]. The main window consists of three components:

Expand Down
17 changes: 10 additions & 7 deletions docs/_ug/TryingFirstCommand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ To let you become more familiar with FoodRem, let's practice executing some [[ c

To start off, let's try out the `new` command! This command lets you add an [Item](#item) to FoodRem.

{% include page-break.html %}

One of the available commands in FoodRem is the command to create a new item.

**Format:** `new n/ITEM_NAME [qty/QUANTITY] [u/UNIT] [bgt/BOUGHT_DATE] [exp/EXPIRY_DATE] [p/PRICE] [r/REMARKS]`
Expand All @@ -22,17 +24,16 @@ Notice that there is a pair of square brackets `[]` surrounding some [[ paramete
The [Placeholder](#placeholders) section covers the restrictions for respective placeholders. For example, the date format of BOUGHT_DATE, certain characters you cannot use and the limit and precision of numbers.
```

{% include page-break.html %}

**Let's try an example!**

Suppose you just bought 30 kg worth of potatoes, today is 5th September 2022, and you do not feel the need to record an [[ expiry-date:expiry date ]], price or remarks for this item.

`ITEM_NAME`: Potatoes

`QUANTITY`: 30

`UNIT`: kg

`BOUGHT_DATE`: 05-09-2022
`ITEM_NAME`: Potatoes<br>
`QUANTITY`: 30<br>
`UNIT`: kg<br>
`BOUGHT_DATE`: 05-09-2022<br>

The command you would like to enter into the command box would be:

Expand Down Expand Up @@ -66,6 +67,8 @@ Find out more about restrictions in the sections [Flags](#flags), [Placeholders]

---

{% include page-break.html %}

Let's try out another command -- the `inc` command! `inc` lets you increment the quantity of an item.

```warning
Expand Down
8 changes: 6 additions & 2 deletions docs/_ug/commands/ItemCommands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,11 @@ The command will produce a detailed view of this item.

---

{% include page-break.html %}

#### Increment the quantity of an item: `inc`

**Format:**: `inc INDEX [qty/QUANTITY]`
**Format:** `inc INDEX [qty/QUANTITY]`

> Increments the quantity of the item at the specified index

Expand All @@ -225,9 +227,11 @@ The command will produce a detailed view of this item.

---

{% include page-break.html %}

#### Decrement the quantity of an item: `dec`

**Format:**: `dec INDEX [qty/QUANTITY]`
**Format:** `dec INDEX [qty/QUANTITY]`
> Decrements the quantity of the item at the specified index

```info
Expand Down