<commit_before># Overview

Incite is an academic citation library that lets you easily define objects for typical academic sources (eg. books, articles) which can be used to output formatted html for a variety of bibliographical formats (eg. Chicago Manual of Style, MLA).  Right now only CMS is supported.

Incite is in alpha alpha stage.  It's useless, don't install it.

# Usage

* Note: This syntax is very experimental, and will likely--no, definitely--change in a radical way (see above).

```
irb> require 'lib/incite'
=> true
```

First you need to instantiate a source you want to cite:

```
irb> source = Incite::Source.new
=> #<Incite::Source:0x8c5f0>
```

Sources don't require any parameters to be created, but obviously you're not going to get a very useful citation:

```
irb> source.citation(:Note)
=> ", <em></em> (: , ), ."
```

So lets add some metadata and try again. When we're talking about citations, proper attribution is usually the most pressing task:

```
irb> source.authors = ["Some Guy", "<NAME>"]
=> ["Some Guy", "Smart Gal"]
irb> source.citation(:Note)
=> "Smart Gal and Some Guy, <em></em> (: , ), ."
```

OK.  That's a little better.  It's even sorted them for you!  Unfortunately...it also spat out a bunch of garbage relating to other unavailable data.  In the future the plan is for Incite to be intelligent about how to format 'partial' sources (this has begun to be implemented, but needs to be a lot more robust).

# Other future plans

* Integration with various bibliographies (Google Books, Amazon, &c?)
* Citation text
* Source types
* Minimal validations of metadata
* Different type of formats (to_s, to_rtf)<commit_msg>Tweaked README<commit_after># Overview

Incite is an academic citation library that lets you easily define objects for typical academic sources (eg. books, articles) which can be used to output formatted html for a variety of bibliographical formats (eg. Chicago Manual of Style, MLA).  Right now only CMS is supported.

Incite is in alpha alpha stage.  It's useless, don't install it.

# Usage

* Note: This syntax is very experimental, and will likely--no, definitely--change in a radical way (see above).

```
irb> require 'lib/incite'
=> true
```

First you need to instantiate a source you want to cite:

```
irb> source = Incite::Source.new
=> #<Incite::Source:0x8c5f0>
```

Sources don't require any parameters to be created, but obviously you're not going to get a very useful citation:

```
irb> source.citation(:note)
=> ", <em></em> (: , ), ."
```

So lets add some metadata and try again. When we're talking about citations, proper attribution is usually the most pressing task:

```
irb> source.authors = ["Some Guy", "<NAME>"]
=> ["Some Guy", "<NAME>"]
irb> source.citation(:note)
=> "Smart Gal and Some Guy, <em></em> (: , ), ."
```

OK.  That's a little better.  It's even sorted them for you!  Unfortunately...it also spat out a bunch of garbage relating to other unavailable data.  In the future the plan is for Incite to be intelligent about how to format 'partial' sources (this has begun to be implemented, but needs to be a lot more robust).

# Other future plans

* Integration with various bibliographies (Google Books, Amazon, &c?)
* Citation text
* Source types
* Minimal validations of metadata
* Different type of formats (to_s, to_rtf)
{'fraction_non_alphanumeric': 0.1063063063063063, 'fraction_numerical': 0.0024024024024024023, 'mean_word_length': 4.312599681020734, 'pattern_counts': {'":': 0, '<': 16, '<?xml version=': 0, '>': 36, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3031619', 'n_tokens_mistral': 994, 'n_tokens_neox': 923, 'n_words': 467}