<commit_before>scribly
=======

Scribly is a javascript object made to allow for the dynamic creation of editable text elements within a webpage. It includes functionality for storing the values of the edited fields locally to send back to the server (yourself), or to opt-out of local storage all together.

Use
===

The object comes with one property and several methods:
* `storeLocally`
  * this tells scribly whether to store the edits in local storage
  * by default this is set to true

* `editByTag(tag, inputType)`
  * provide the HTML tag of the elements that you want editable
  * use `text` or `textarea` for the inputType, defaults to `text`

* `editByClass(class, inputType)`
  * provide the class selector of the elements you want editable

* `editById(id, inputType)`
  * provide the id selector of the element you want editable

* `save(parent)`
  * updates the elements text
  * provide a parent element to search through or leave blank to save all within the document

* `close(parent)`
  * reverts the elements back to their original state, saves no edits
  * provide a parent element to search through or leave blank to save all within the document<commit_msg>elaborated a little<commit_after>scribly
=======

Scribly is a javascript object made to allow for the dynamic creation of editable text elements within a webpage. It includes functionality for storing the values of the edited fields locally to send back to the server (yourself), or to opt-out of local storage all together.

Use
===

The object comes with one property and several methods:
* `storeLocally`
  * this tells scribly whether to store the edits in local storage
  * by default this is set to true

* `editByTag(tag, inputType)`
  * provide the HTML tag of the elements that you want editable
  * use `text` or `textarea` for the inputType, defaults to `text`

* `editByClass(class, inputType)`
  * provide the class selector of the elements you want editable

* `editById(id, inputType)`
  * provide the id selector of the element you want editable

* `save(parent)`
  * updates the elements text
  * provide a parent element (must be HTML element object) to search through or leave blank to save all within the document

* `close(parent)`
  * reverts the elements back to their original state, saves no edits
  * provide a parent element (must be HTML element object) to search through or leave blank to save all within the document
{'fraction_non_alphanumeric': 0.05848434925864909, 'fraction_numerical': 0.0, 'mean_word_length': 4.362030905077263, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '3763868', 'n_tokens_mistral': 639, 'n_tokens_neox': 626, 'n_words': 355}