<commit_before>Typus
=====

As Django Admin, Typus is designed for a single activity:

> Trusted users editing structured content.

Once installed and configured you can login at http://application.tld/admin/

Note: Typus doesn't try to be all the thing to all the people.

## Installing

You can view the available tasks running

    rake typus

### Step 1: Install extra plugins

    rake typus:dependencies

This task will install for you:

- Gem `paginator`
- `paperclip` File upload
- `acts_as_list`
- `acts_as_tree`

### Step 2: Copy stylesheets to your public/ folder.

    rake typus:assets

### Step 3: Create an initial configuration file at `config/typus.yml`

    rake typus:configure

### Step 4: Create the needed tables on the db by running.

    script/generate typus_migration
    rake db:migrate
    rake typus:seed email='<EMAIL>' RAILS_ENV=production

### Step 5: Start your application

Start your application and go to http://application.tld/admin/

## Plugin Configuration Options

You can overwriting the following settings:

    Typus::Configuration.options[:app_name] = "Your app name"
    Typus::Configuration.options[:app_description] = "App Details"
    Typus::Configuration.options[:per_page] = "20"
    Typus::Configuration.options[:form_rows] = "20"
    Typus::Configuration.options[:form_columns] = "20"
    Typus::Configuration.options[:color] = "20"
    Typus::Configuration.options[:app_logo] = "url/to/application/logo"
    Typus::Configuration.options[:app_logo_height] = "400px"
    Typus::Configuration.options[:app_logo_width] = "400px"

Place this settings in a initializer at <code>config/initializers/typus.rb</code>.

## Configuration file options

If the configuration file is broken you'll see a +typus.yml+ text on the admin interface.

### Typus Fields<commit_msg>Fixed typos<commit_after>Typus
=====

As Django Admin, Typus is designed for a single activity:

> Trusted users editing structured content.

Once installed and configured you can login at http://application.tld/admin/

Note: Typus doesn't try to be all the things to all the people.

## Installing

You can view the available tasks running

    rake typus

### Step 1: Install extra plugins.

    rake typus:dependencies

This task will install for you:

- Gem `paginator`
- `paperclip` File upload
- `acts_as_list`
- `acts_as_tree`

### Step 2: Copy stylesheets to your public/ folder.

    rake typus:assets

### Step 3: Create an initial configuration file at `config/typus.yml`.

    rake typus:configure

### Step 4: Create the needed tables on the db by running.

    script/generate typus_migration
    rake db:migrate
    rake typus:seed email='<EMAIL>' RAILS_ENV=production

### Step 5: Start your application.

Start your application and go to http://application.tld/admin/

## Plugin Configuration Options

You can overwriting the following settings:

    Typus::Configuration.options[:app_name] = "Your app name"
    Typus::Configuration.options[:app_description] = "App Details"
    Typus::Configuration.options[:per_page] = "20"
    Typus::Configuration.options[:form_rows] = "20"
    Typus::Configuration.options[:form_columns] = "20"
    Typus::Configuration.options[:color] = "20"
    Typus::Configuration.options[:app_logo] = "url/to/application/logo"
    Typus::Configuration.options[:app_logo_height] = "400px"
    Typus::Configuration.options[:app_logo_width] = "400px"

Place this settings in a initializer at <code>config/initializers/typus.rb</code>.

## Configuration file options

If the configuration file is broken you'll see a +typus.yml+ text on the admin interface.

### Typus Fields
{'fraction_non_alphanumeric': 0.10391400220507166, 'fraction_numerical': 0.010474090407938258, 'mean_word_length': 4.424514200298954, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 11, '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': '3046838', 'n_tokens_mistral': 1123, 'n_tokens_neox': 1054, 'n_words': 356}