<commit_before># HtmlTools #

various html tools I've created


## BreadCrumb ##

A library to add dynamicly generated bread crumbs to a site via HTML 5 Session Storage

### Use ###

create a BreadCrumb object

```javascript
//----
// a call with no parameters will default to the current url as a base url and 
//      " -> " as the separator string
//----
var objBreadCrumb = new BreadCrumb();

//----
// OR
//----
// basic call with an argument object with 'BaseURL' and 'Separator' properties
//----
var objBreadCrumb = new BreadCrumb({BaseURL: "http://www.yoursite.com/", Separator: " -> "});

//----
// OR
//----
// adding the Clear parameter will clear the breadcrumb history
//----
var objBreadCrumb = new BreadCrumb({BaseURL: "http://www.yoursite.com/", Separator: " -> ", Clear: true});
```

Add the current page:

```javascript
//----
// BreadCrumb.Add("URL", "Display Name")
//----
objBreadCrumb.Add(window.location.toString(), document.title);
```

Call Generate to render the breadcrumbs into html

```javascript
//----
// to generate simple links
//----
strCrumbs = objBreadCrumb.Generate(); //or objBreadCrumb.Generate('simple')

//----
// or plain text
//----
strCrumbs = objBreadCrumb.Generate('text');

//----
// or links where the following classes can be used for styling
//      'crumb-holder' -- container around crumb link
//      'crumb-link' -- the link itself
//      'crumb-separator' -- the separating text
//----
strCrumbs = objBreadCrumb.Generate('style');
```

Place the crumbs in the page

```javascript
querySelector('#breadcrumbs').innerHTML = strCrumbs;
```

### Other methods ###

BreadCrumb.Clear() -- removes all crumbs
BreadCrumb.Delete() -- removes the session storage


## LayoutTests ##

These are various layout tests I've played with over the years ... hopefully I'll add more of them soon
<commit_msg>fixing formatting issue in README.md<commit_after># HtmlTools #

various html tools I've created


## BreadCrumb ##

A library to add dynamicly generated bread crumbs to a site via HTML 5 Session Storage

### Use ###

create a BreadCrumb object

```javascript
//----
// a call with no parameters will default to the current url as a base url and 
//      " -> " as the separator string
//----
var objBreadCrumb = new BreadCrumb();

//----
// OR
//----
// basic call with an argument object with 'BaseURL' and 'Separator' properties
//----
var objBreadCrumb = new BreadCrumb({BaseURL: "http://www.yoursite.com/", Separator: " -> "});

//----
// OR
//----
// adding the Clear parameter will clear the breadcrumb history
//----
var objBreadCrumb = new BreadCrumb({BaseURL: "http://www.yoursite.com/", Separator: " -> ", Clear: true});
```

Add the current page:

```javascript
//----
// BreadCrumb.Add("URL", "Display Name")
//----
objBreadCrumb.Add(window.location.toString(), document.title);
```

Call Generate to render the breadcrumbs into html

```javascript
//----
// to generate simple links
//----
strCrumbs = objBreadCrumb.Generate(); //or objBreadCrumb.Generate('simple')

//----
// or plain text
//----
strCrumbs = objBreadCrumb.Generate('text');

//----
// or links where the following classes can be used for styling
//      'crumb-holder' -- container around crumb link
//      'crumb-link' -- the link itself
//      'crumb-separator' -- the separating text
//----
strCrumbs = objBreadCrumb.Generate('style');
```

Place the crumbs in the page

```javascript
querySelector('#breadcrumbs').innerHTML = strCrumbs;
```

### Other methods ###

BreadCrumb.Clear() -- removes all crumbs

BreadCrumb.Delete() -- removes the session storage


## LayoutTests ##

These are various layout tests I've played with over the years ... hopefully I'll add more of them soon

{'fraction_non_alphanumeric': 0.16756320602474448, 'fraction_numerical': 0.0005379236148466917, 'mean_word_length': 3.0205405405405403, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, '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': '152773', 'n_tokens_mistral': 1165, 'n_tokens_neox': 1127, 'n_words': 378}