TagCite

---

This utility aids in the organization of your papers and citations through usage of tagging, titling, and tag clouds.

Table of Contents

• About
• Feature List
• Getting Started
• The TagCite Format
• Getting Started with Development
• Built Using
• Authors
• Acknowledgments

About

TagCite serves as a platform to visualize and explore a tagged text file. The utility itself is a single HTML file that can be run locally or can be hosted anywhere. A text file would consist of items with a description, a title, tags, and authors.

TagCite functions as a way to organize your knowledge in a restricted environment where usage of external executables is discouraged but a browser is accessible.

TagCite works in all modern browsers (Google Chrome, Firefox, Safari, etc) or Internet Explorer 10+.

Feature List

• Sleek UI
• Weighted Tags
• Weighted Authors
• Search your Authors or Tags
• Jump between linked tags or authors

Getting Started

1. Head to the releases page (HERE) to download the latest copy of the TagCite .html file.

2. Run the .html file locally with your favourite browser or host it and access it.

3. Once TagCite has displayed, drag and drop your tagged text file onto the drop area. If you're using Internet Explorer, you'll need to click the drop area and manually select your text file. Your tags should be organized and displayed!

For more information on TagCite's format, please consult the next section.

The TagCite Format

TagCite accepts text files with appropriately tagged items. Each item is denoted with two or more new line characters (usually two presses of the enter key).

The end of each item may contain:

• A tag, denoted by a # + the tag name (Eg: #tag_name). No spaces can be present.
• An author, denoted by an @ + the author's name (Eg: #author_name). No spaces can be present.
• A title, denoted by two square brackets (Eg: [[Title Goes Here]]). The title may contain spaces.

Any of the above fields may be omitted. If all are omitted, the item will show up under the "!UNFILED" tag.

Example

This is the content section of a tag.
You can have single new lines in here (but not double since that denotes an item). Use this space to include a citation, hyperlinks, a description or other information. The meta data now follows. 
[[This is the Title for this Item]] @author_1 @author_2 #tag1 #tag2

Here is another item. More information pertaining to another idea could be put here.
[[This is Another Title]] @author_2 @tag2

Which would render:

Getting Start with Development

These instructions help you get a copy of the project up and running on your local machine for development.

Prerequisites

• NodeJS
• NPM

Setup

Clone the project into a directory of your choice and install the node packages.

git clone https://github.com/brikwerk/tagcite
cd tagcite
npm install

You're now ready for TagCite development!

Compiling TagCite

Manually Building

For a production build with minified assets

npm run build:dist

or with non-minified assets for debugging and inspection

npm run build:dev

The above commands will generate a .html file in the "dist" folder located at the root of the project.

Automatically Building

To automatically compile when assets are changed during development:

For a production build

npm run start:dist

or for a development build

npm run start:dev

Built Using

• Webpack
• Babel
• Inline HTML

Author

• @brikwerk

Acknowledgements

• Thanks to Thor Bjarnason for the initial idea and your valuable feedback in the development of this utility. Without your input this wouldn't exist!