Collection Mode

What Collection Mode Does

Collection Mode takes a list of articles from PLoS and packages them neatly into a single ePub file. You may wish to do this to package an entire Journal Issue, to create a compendium on a common topic, or to create a reading list of articles which can be moved as a single file for easier distribution and use in your reading system. You supply a list of articles in the order you would like them to be read in the form of a text file, then call the program on that list and it generates a valid ePub file containing all the articles.

Please note that due to ePub specifications, some metadata for individual articles will not be included when packaged into a Collection

Using Collection Mode

To use Collection Mode at the command line, the first thing that you must do is create a list of the articles you would like to include in your Collection. Feel free to mix and match inputs as URLs, DOIs, or local files like so:

downloaded_xml_files/journal.pmed.1001067.xml
http://www.plosmedicine.org/article/info%3Adoi%2F10.1371%2Fjournal.pmed.1001064
doi:10.1371/journal.pmed.1001063
downloaded_xml_files/journal.pmed.1001061.xml

Place this list in a text file named "HIV_Reading_List.txt" and save it. The name of the text file will be the name of the Collection when complete, in this case "HIV_Reading_List.epub"

Collection Mode is activated at the command line with either -C or --collection and requires a path to a text file containing your list.

python main.py -C HIV_Reading_List.txt -o Collections

This would produce "HIV_Reading_List.epub" inside a folder named Collections.