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

Update documents #264

Merged
merged 7 commits into from
Nov 11, 2019
Merged

Update documents #264

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
158f76c
Update docs
moziliar Nov 10, 2019
9329355
Update docs
moziliar Nov 10, 2019
a57f7ff
Relocate like_icon
moziliar Nov 10, 2019
3d5f69b
Update fxml
moziliar Nov 10, 2019
3f05916
Update v2.0 feature
moziliar Nov 10, 2019
2613b48
Merge branch 'master' into mo/update-documents
moziliar Nov 11, 2019
366ab97
Update docs
moziliar Nov 11, 2019
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/DeveloperGuide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ The following sequence diagram shows how `MemeLikeCommand` communicates with `St

image::LikeMemeSequenceDiagram.png[]

In the `CommandBox`, `UP` and `DOWN` keys are used for easy execution of `LikeCommand` and `DislikeCommand`.
In the `CommandBox`, `UP` key is used for easy execution of `LikeCommand` and `DislikeCommand`.
This allows the user to like a meme conveniently as he/she can press the key until he/she feels like stopping.
`LEFT` and `RIGHT` keys are used for toggling the index in the complete command.
For example, when command `Like 2` is inside the command text box, where 2 is a valid index of a meme displayed,
Expand Down
8 changes: 4 additions & 4 deletions docs/UserGuide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@ Likes a meme at the specified index. +
Format: `like INDEX`

[TIP]
You could use arrow key kbd:[Up] to quickly like a meme at the given index. +
To do this, key in the full command `like INDEX` then press arrow key kbd:[Up]. +
You can also use arrow key kbd:[Left] and kbd:[Right] to increase / decrease the meme index.
You could use arrow key kbd:[UP] to quickly like a meme at the given index. +
To do this, key in the full command `like INDEX` then press arrow key kbd:[UP]. +
You can also use arrow key kbd:[LEFT] and kbd:[RIGHT] to increase / decrease the meme index.

==== Disliking a meme: `dislike`

Expand Down Expand Up @@ -514,7 +514,7 @@ Format: `clear`

=== Statistics Tab

View various statistics about the memes such as tags and likes count by tags, and most used templates.
View various statistics about the memes such as tags and likes count by tags.

// tag::command-suggestion[]
=== Command Suggestions
Expand Down
0 src/main/resources/images/like_icon.png → docs/images/like_icon.png
View file
Open in desktop
File renamed without changes
Binary file modified docs/images/moziliar.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/team/moziliar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ the statistics data is stored in a similar fashion as the memes. As such, an und
and JavaFX is required.
** Credits: AddressBook 3 implementation gave rise to the infrastructure of the statistics feature.

* *Minor enhancement*: created wrapper class ImagePath during morphing stage for internal use.
* *Minor enhancement*:
** created wrapper class ImagePath during morphing stage for internal use.
Copy link

Choose a reason for hiding this comment

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

You might want to put a pr link to your enhancements.

** Restyle view panel for better UX as user can view long memes.
** Improve UI logic to allow display of multiple tags without content overflow.

* *Code contributed*: [https://nus-cs2103-ay1920s1.github.io/tp-dashboard/#search=moziliar&sort=groupTitle&sortWithin=title&since=2019-09-06&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false[RepoSense code]]

Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/view/MemeGridCard.fxml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<children>
<HBox alignment="CENTER_RIGHT" prefHeight="24.0" prefWidth="240.0">
<ImageView fx:id="likeIcon" cache="true" cacheHint="SPEED" fitHeight="11.0" fitWidth="13.0" pickOnBounds="true" preserveRatio="true">
<Image requestedHeight="11.0" requestedWidth="13.0" smooth="true" url="@../images/like_icon.png" />
<Image requestedHeight="11.0" requestedWidth="13.0" smooth="true" url="@../../../../docs/images/like_icon.png" />
moziliar marked this conversation as resolved.
Show resolved Hide resolved
</ImageView>
<Label fx:id="likes" alignment="CENTER_RIGHT" contentDisplay="RIGHT" styleClass="cell_small_label" />
<ImageView fx:id="dislikeIcon" cache="true" cacheHint="SPEED" fitHeight="11.0" fitWidth="13.0" pickOnBounds="true" preserveRatio="true">
Expand Down