Merge pull request #199 from melpulomas/master

Fix error and edit documentation for v1.4

docs/DeveloperGuide.adoc

@@ -496,7 +496,7 @@ Fig 4.4 UML sequence diagram
 image::label2_taken.png[width="790"]
 Fig 4.4.1.1
 
-image::mainPDF.png[width="790"]
+image::folderPDF.png[width="790"]
 Fig 4.4.1.2 (PDF folder highlighted)
 
 ===== Label command with filename behaviour:
@@ -1190,4 +1190,28 @@ Expected: Warning panel's "Low in Stock" list empties and placeholder "Nothing t
 Expected: No changes to warning panel. Error details shown in the status message.
 .. Other incorrect warning commands to try: `warning`, `warning q/x` (where x is not a positive integer), `warning {non-whitespace preamble} q/y` (where y is a positive integer) +
 Expected: Similar to previous.
+
 // end::warningtest[]
+
+// tag::labeltest[]
+=== Labeling medicine information onto a PDF file
+
+. Output a medicine information onto a PDF file using default name.
+
+.. Prerequisites: List all medicines using the `list` command. There is at least a medicine in the first index
+
+.. Test case: `label 1` +
+Expected: Success message shown in the UI. Current medicine on index one is successfully output to a PDF file under the PDF folder. Filename is `to_print`.
+.. Test case: `label` +
+Expected: Unsuccessful message shown in the UI. No file will be output in the PDF folder.
+
+. Output a medicine information onto a PDF file with its name given by the user. Filename must follow Appendix A. Else, error message is shown.
+
+.. Prerequisites: List all medicines using the `list` command. There is at least a medicine in the first index
+
+.. Test case: `label 1 f/newfile` +
+Expected: Success message shown in the UI. Current medicine on index one is successfully output to a PDF file under the PDF folder. Filename is `newfile`.
+.. Test case: `label 1 f/^@#&` +
+Expected: Expected: Unsuccessful message shown in the UI. No file will be output in the PDF folder.
+
+// end::labeltest[]

docs/UserGuide.adoc

@@ -187,6 +187,7 @@ This feature can be improved to support medical databases of different countries
 Due to the nature of medical inventories, the integrity of data stored is of utmost importance. The next release will feature data encryption to keep your inventory safe and keep unauthorised users away. With this feature, you will be required to log in with a password to view and edit your inventory. This feature can be disabled if it is not required for your needs.
 // end::dataencryption[]
 
+// tag::previewresults[]
 ==== Preview of results
 
 . Preview of results for Export and Label Commands to be available in the UI.
@@ -195,10 +196,13 @@ Due to the nature of medical inventories, the integrity of data stored is of utm
 - Below is a mock up on how the UI may look like with the features integrated.
 
 image::MockUp.png[width="790"]
+// end::previewresults[]
 
+// tag::importpictures[]
 ==== Importing pictures
 . Import of pictures to aid in the medicine identification.
 - Pictures and snapshot of the medicine may be added to MediTabs such that it is easier for you to identify what the physical medicine looks like.
+// end::importpictures[]
 
 [[Commands]]
 == Commands
@@ -479,15 +483,15 @@ This includes the company that manufactured it, expiry date and the tags that wa
 
 All PDF files can be found under the PDF folder
 
-image::mainPDF.png[width="790"]
+image::folderPDF.png[width="790"]
 
 Fig 5.12.1 PDF folder highlighted
 
 Examples:
 
 .  Open up the software interface. (Fig 5.12.2)
 +
-image::blankUI.png[width="790"]
+image::Ui.png[width="790"]
 +
 Fig 5.12.2 Software interface
 +

docs/team/melpulomas.adoc

@@ -6,34 +6,37 @@
 == PROJECT: MediTabs
 
 == Introduction
-This  Project Portfolio shows my contributions to the group project, such as features and documentation.
+This  Project Portfolio shows my contributions to the group project, such as features and documentation. I was in charge of the of the logic component, which mainly focus on the command features of the project. This project is under a core module of software engineering in the my school.
 
 
 == Overview
 
 The group project, Meditabs, is a medicine inventory management for pharmacist to streamline the process of handling the stick taking process. The user mainly uses the Command-Line Interface (CLI) to interact.
+Upon looking  at user case, we implemented a label function to allow the pharmacist to print out the medicine information. This is for easier management for the physical medicine itself.
 
 == Summary of contributions
 
 * *Major enhancement*: Added the `Label` command
 ** What it does: Allows the user to output the information of the medicine onto a Portable Document Format (PDF).
 ** Justification: Pharmacist would like to have the printed information of certain medicine and label the physical counterpart. With the PDF, the pharmacist may use external printers and print out the information on the label as a sticker. PDF is widely used as a file extension.
-** Highlights: Added security layer to the naming of the file (Auto include .pdf extension) such that users may not over write other important files.
-** Credits: Apache PDFBox external library is imported to help manipulate and output the stream of information to the PDF file.
+** Highlights: Added security layer to the naming of the file (Auto include .pdf extension) such that users may not over write other important files. Also set a limit on the the length of filename.
+** Credits: Apache PDFBox external library is imported to help manipulate and output the stream of information to the PDF file. More information can be found under: https://pdfbox.apache.org/
 
 * *Minor enhancement*: -
 
-* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
+* *Code contributed*: https://nus-cs2103-ay1819s2.github.io/cs2103-dashboard/#=undefined&search=melpulomas[Project Code Dashboard]
 
 * *Other contributions*:
 
 ** Project management:
 *** Wrote additional tests for existing features to increase coverage (Pull requests https://github.com/CS2103-AY1819S2-T12-3/main/pull/131[#131], https://github.com/CS2103-AY1819S2-T12-3/main/pull/142[#142])
+*** Refactor test cases: (Pull requests https://github.com/CS2103-AY1819S2-T12-3/main/pull/78[#78])
 ** Community:
 *** PRs reviewed (with non-trivial review comments): https://github.com/CS2103-AY1819S2-T12-3/main/pull/103[#103], https://github.com/CS2103-AY1819S2-T12-3/main/pull/124[#124]
 ** Documentation:
-*** Added label command to the User Guide: https://github.com/CS2103-AY1819S2-T12-3/main/pull/106[#106]
-*** Changed About Us documentation to describe our group instead: https://github.com/CS2103-AY1819S2-T12-3/main/pull/24[#24], https://github.com/CS2103-AY1819S2-T12-3/main/pull/27[#27]
+*** Added label command to the User Guide: (Pull requests https://github.com/CS2103-AY1819S2-T12-3/main/pull/106[#106], https://github.com/CS2103-AY1819S2-T12-3/main/pull/191[#191])
+*** Added label command to the Developer Guide: (Pull requests https://github.com/CS2103-AY1819S2-T12-3/main/pull/106[#106], https://github.com/CS2103-AY1819S2-T12-3/main/pull/191[#191])
+*** Changed About Us documentation to describe our group: https://github.com/CS2103-AY1819S2-T12-3/main/pull/24[#24], https://github.com/CS2103-AY1819S2-T12-3/main/pull/27[#27]
 ** Tools:
 *** Integrated third party libraries (Apache PDFBox) to the project: https://github.com/CS2103-AY1819S2-T12-3/main/pull/40[#40]
 
@@ -45,6 +48,8 @@ The group project, Meditabs, is a medicine inventory management for pharmacist t
 |===
 
 include::../UserGuide.adoc[tag=labelcommand]
+include::../UserGuide.adoc[tag=previewresults]
+include::../UserGuide.adoc[tag=importpictures]
 
 == Contributions to the Developer Guide
 
@@ -53,3 +58,4 @@ include::../UserGuide.adoc[tag=labelcommand]
 |===
 
 include::../DeveloperGuide.adoc[tag=labelcommand]
+include::../DeveloperGuide.adoc[tag=labeltest]