User-Guide.md

About

Now that you know what Collate is about, you can follow this guide to learn how to use Collate effectively.

Table of Contents

• Quick Start
• Feature Details
  • Marking code
  • Collating
    • Omitting sub folders
    • Collating only certain types of files
  • Viewing an author's statistics
  • Viewing the summary
  • Exiting
  • Using the Text UI
• Cheatsheet

Quick Start

1. Install JDK 8u40 or later: Earlier Java version will not work. You can get it [here] (http://www.oracle.com/technetwork/java/javase/downloads/index.html).

2. Download Collate: You can then download Collate-GUI.jar from the latest release here: https://github.com/collate/collate/releases

3. Mark your code with @@author tags: Here are some examples.

   For .fxml files, ensure that the xml tag comes before your author tags

   

4. Launch Collate Simply double-click on the Collate-GUI.jar file to start Collate. You will be greeted with a simple interface that has a command bar. This command bar is where you enter short commands to tell Collate what to do.
   

5. Ask Collate to collate your code. As shown in the above animation, you can type collate from <FOLDER> to collate all files within <FOLDER> including subfolders.

6. View reports: The reports can be found in a folder called collated. You'll find one .md for each author, containing the code written by that author. Here is an example.

7. Try more commands:

   • view <AUTHOR'S NAME> - See author's individual statistics e.g. view Sebastian
   • summary - See the default statistics summary table
   • exit - Exit Collate using the command bar

To learn more details of Collate features, refer to the 'Feature Details' section below.

Feature Details

Marking code

Using the @@author tag, you can specify the lines of code that you have written. Lines between your author tag and the next author tag will be marked as yours. Your name can include letters and numbers.

Tip: Make sure to use the same name so that the code you wrote will be saved correctly in a single file.

You can include any type of file, as long as the @@author tag is present.

You can also use an empty author tag (i.e. an author tag without an author name) to mark end of your code segment. Empty author tags are helpful to avoid claiming code written by another author who has yet to enter his/her author tags.

Collating

To collate files in a folder and all its sub folders, use this command.

collate from <FOLDER>

Tip: If your folder includes whitespaces, you will need to surround the folder with double inverted commas.

Examples:

• collate from src
• collate from .
• collate from C:/myProject/component1/src
• collate from "C:/source files"

Omitting sub folders

If you would like to collate files only from the specified folder, and not files from sub folders, you can add the only option.

collate from <FOLDER> only or collate only from <FOLDER>

Tip: option order of the collate command is flexible. You need not worry about the position of these options, just remember to start each command with the collate keyword.

Examples:

• collate from C:/myProject/component1/src only
• collate only from C:/myProject/component1/src

Collating only certain types of files

Collate scans the folder you specified for all types of file. What if you want to collate only java files? Well, you can use the include option.

collate from <FOLDER> include java

You can include multiple filetypes by separating them with commas.

collate from <FOLDER> include java, css, fxml

Examples:

• collate from C:/src java
• collate from C:/src java,md,css,txt

Viewing an author's statistics

Viewing an author's contribution statistics can be done by entering the following command.

view <AUTHOR's NAME>

Tip: To make using Collate easier, the author's name is not case-sensitive.

This view allows you to see the proportion and number of lines of code the author wrote for files he/she contributed to.

Viewing the summary

The summary view is the default screen that shows you the contributions of all authors. To access it, simply enter the following.

summary

Exiting

Simply close the window or type the following command in the command bar.

exit

Using the Text UI

Collate also provide a version that uses a Text UI instead of a GUI. To use it, first download the Collate-TUI.jar from the same location. Then, open a command window in the same folder as Collate-TUI.jar and enter java -jar Collate-TUI.jar. You can then enter commands described earlier this this document within the command window.

Here are some examples:

Cheatsheet

Command	Description
collate from <FOLDER>	Collate all files within <FOLDER> including subfolders
collate from <FOLDER> only	Collate files in <FOLDER> only
collate from <FOLDER> include <FILETYPE1>, <FILETYPE2>	Collate <FILETYPE1> and <FILETYPE2> files in <FOLDER> and its subfolders
collate from <FOLDER> only include <FILETYPE1>	Collate <FILETYPE1> files in <FOLDER> only
view <AUTHOR'S NAME>	See author's individual statistics
summary	See default statistics summary table
exit	Exit Collate