Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
willtheorangeguy committed Apr 14, 2022
1 parent 1a54fec commit 27240e5
Show file tree
Hide file tree
Showing 6 changed files with 315 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ However, **to make this your own directory**, either use the `index_chromium.htm
```

5. _Line 75_: If this is a directory inside of another directory, change the `up/level` placeholder in the `href="..."` tag with the actual link to the folder above.

```html
<a id="parentDirLink" href="up/level" class="icon up">
```

6. When you have customized the title, and added folder and file listings following the tutorials below, save the files and upload them to your web server.
7. You're all set!

Expand Down
82 changes: 82 additions & 0 deletions docs/CUSTOMIZATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Chrome File Directory Customization

The Chrome File Directory has been designed to be heavily customizable. More file and folder listings can be added, and directory paths can be changed, and the icons for each type of file can be changed. **Just search for and change the placeholder values in each code section.** Additionally, ensure that you have deleted all the extra file and folder rows that are unnecessary for your file listing, so not to confuse users.

All of these instructions require [a text editor](https://code.visualstudio.com/) to be installed.

## Basics

1. If you would rather have the styling for the page in its own separate location, copy the `style.css` file to that location and link it in the top of the `index.html` file. To do so, follow the steps below:
1. Delete lines 9 through 68.
2. Find the link to the `style.css` file.
3. Add `<link rel="stylesheet" href="style.css">` to line 9.
4. Update the link between the `href="..."` to the exact link to the `style.css` file.
5. You're all set to have an external style sheet!

2. _Line 69_: Update the `example` placeholder text between the `<title>` tags with the actual directory name. This will be the title of the webpage.

```html
<title id="title">Index of example</title>
```

3. _Line 73_: Update the `:\directory` placeholder text between the `<h1>` tags with the actual directory path. This will be the title displayed on the page.

```html
<h1 id="header">Index of :\directory</h1>
```

4. _Line 74_: If this is a directory inside of another directory, remove the `style="display:none"` placeholder in the `div` tag.

```html
<div id="parentDirLinkBox" style="display:none">
```

5. _Line 75_: If this is a directory inside of another directory, change the `up/level` placeholder in the `href="..."` tag with the actual link to the folder above.

```html
<a id="parentDirLink" href="up/level" class="icon up">
```

6. When you have customized the title, and added folder and file listings following the tutorials below, save the files and upload them to your web server.
7. You're all set!

## For a Folder

```html
<tr>
<td data-value="Folder"><a class="icon dir" href="link/to/folder">Folder</a></td>
<td class="detailsColumn" data-value="0"></td><td class="detailsColumn">MM/DD/YY, HH:MM:SS PM</td>
</tr>
```

* Replace the `"Folder"` placeholder value (between the `data-value="..."` tag) with the real name of the folder.
* Replace the `"link/to/folder"` link (between the `href="..."` tag) with the actual link to the folder.
* Replace the `Folder` placeholder name (between the `<a>...</a>` tag) with the real name of the folder.
* Replace the `MM/DD/YY, HH:MM:SS PM` placeholder date with the date the folder was uploaded.
* Add more of these rows as necessary.

## For a File

```html
<tr>
<td data-value="File"><a class="icon file" draggable="true" href="link/to/file">File.txt</a></td>
<td class="detailsColumn">File</td><td class="detailsColumn">0.00 MB</td><td class="detailsColumn">MM/DD/YY, HH:MM:SS PM</td>
</tr>
```

* Replace the `"File"` placeholder value (between the `data-value="..."` tag) with the real name of the file.
* Replace the `"link/to/file"` link (between the `href="..."` tag) with the actual link to the file.
* Replace the `File.txt` placeholder name (between the `<a>...</a>` tag) with the real name and extension of the file.
* Replace the `File` placeholder text with the actual file type.
* Replace the `0.00 MB` placeholder size with the real size of the file.
* Replace the `MM/DD/YY, HH:MM:SS PM` placeholder date with the date and time the file was uploaded.
* Add more of these rows as necessary.

## Change Icons

The icons that are used to represent the different file types can also be changed. To add your own icons, follow these steps:

1. Find icons and save them as a `.ping` file. Ensure the icons are `16`x`16` pixels in size.
2. Move the icons to the `icons` folder.
3. Rename the icons to match the current icons.
4. You're all set!
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Chrome File Directory Documentation

This folder includes all of the docs for the Chrome File Directory. More can be found on the [wiki](https://github.com/willtheorangeguy/Chrome-File-Directory/wiki).

```text
├── docs
| ├── images
| ├── legal
| | ├── PRIVACY.md
| | ├── TERMS.md
| ├── USAGE.md
| ├── CUSTOMIZATION.md
└── README.md
```
8 changes: 8 additions & 0 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Chrome File Directory Usage

1. To install the Chrome File Directory, download the latest `.zip` file from [GitHub Releases](https://github.com/willtheorangeguy/Chrome-File-Directory/releases/latest) page.
2. Extract the `.zip` file using a program like [7-Zip](https://www.7-zip.org/).
3. Copy the `icons` folder, and the `index.html` and `style.css` files to the location on your website server where you want the file directory.
4. Edit the `index.html` file following the instructions in [`CUSTOMIZATION.md`](https://github.com/willtheorangeguy/Chrome-File-Directory/tree/main/docs).
5. Save the file and upload it to your website server.
6. You're all set!
107 changes: 107 additions & 0 deletions docs/legal/PRIVACY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Privacy Policy

Last updated: March 01, 2022.

This Privacy Policy describes Our policies and procedures on the collection, use and disclosure of Your information when You use the Service and tells You about Your privacy rights and how the law protects You.

We use Your Personal data to provide and improve the Service. By using the Service, You agree to the collection and use of information in accordance with this Privacy Policy.

## Interpretation and Definitions

### Interpretation

The words of which the initial letter is capitalized have meanings defined under the following conditions. The following definitions shall have the same meaning regardless of whether they appear in singular or in plural.

### Definitions

For the purposes of this Privacy Policy:

- **Account** means a unique account created for You to access our Service or parts of our Service.
- **Affiliate** means an entity that controls, is controlled by or is under common control with a party, where "control" means ownership of 50% or more of the shares, equity interest or other securities entitled to vote for election of directors or other managing authority.
- **Application** means the software program provided by the Company downloaded by You on any electronic device, named Chrome File Directory.
- **Company** (referred to as either "the Company", "We", "Us" or "Our" in this Agreement) refers to @willtheorangeguy.
- **Country** refers to: British Columbia, Canada.
- **Device** means any device that can access the Service such as a computer, a cellphone or a digital tablet.
- **Personal Data** is any information that relates to an identified or identifiable individual.
- **Service** refers to the Application.
- **Service Provider** means any natural or legal person who processes the data on behalf of the Company. It refers to third-party companies or individuals employed by the Company to facilitate the Service, to provide the Service on behalf of the Company, to perform services related to the Service or to assist the Company in analyzing how the Service is used.
- **Usage Data** refers to data collected automatically, either generated by the use of the Service or from the Service infrastructure itself (for example, the duration of a page visit).
- **You** means the individual accessing or using the Service, or the company, or other legal entity on behalf of which such individual is accessing or using the Service, as applicable.

## Collecting and Using Your Personal Data

## Types of Data Collected

### Personal Data

While using Our Service, We may ask You to provide Us with certain personally identifiable information that can be used to contact or identify You.

### Usage Data

Usage Data is collected automatically and anonymously when using the Service.

### Workout Data

Usage Data is collected automatically and anonymously when using the Service.

## Use of Your Personal Data

The Company may use Personal Data for the following purposes:

- **To provide and maintain our Service**, this data is necessary to create a good user experience that follows all of the objectives set out by the code.

## Retention of Your Personal Data

The Company will retain Your Personal Data only for as long as is necessary for the purposes set out in this Privacy Policy. We will retain and use Your Personal Data to the extent necessary to comply with our legal obligations (for example, if we are required to retain your data to comply with applicable laws), resolve disputes, and enforce our legal agreements and policies.

**Personal data is only recorded locally on the computer, and never sent to servers.**

## Disclosure of Your Personal Data

### Business Transactions

If the Company is involved in a merger, acquisition or asset sale, Your Personal Data may be transferred. We will provide notice before Your Personal Data is transferred and becomes subject to a different Privacy Policy.

### Law Enforcement

Under certain circumstances, the Company may be required to disclose Your Personal Data if required to do so by law or in response to valid requests by public authorities (e.g. a court or a government agency).

### Other Legal Requirements

The Company may disclose Your Personal Data in the good faith belief that such action is necessary to:

- Comply with a legal obligation
- Protect and defend the rights or property of the Company
- Prevent or investigate possible wrongdoing in connection with the Service
- Protect the personal safety of Users of the Service or the public
- Protect against legal liability

## Security of Your Personal Data

The security of Your Personal Data is important to Us, but remember that no method of transmission over the Internet, or method of electronic storage is 100% secure. While We strive to use commercially acceptable means to protect Your Personal Data, We cannot guarantee its absolute security.

## Children's Privacy

Our Service does not address anyone under the age of 13. We do not knowingly collect personally identifiable information from anyone under the age of 13. If You are a parent or guardian and You are aware that Your child has provided Us with Personal Data, please contact Us. If We become aware that We have collected Personal Data from anyone under the age of 13 without verification of parental consent, We take steps to remove that information from Our servers.

If We need to rely on consent as a legal basis for processing Your information and Your country requires consent from a parent, We may require Your parent's consent before We collect and use that information.

## Links to Other Websites

Our Service may contain links to other websites that are not operated by Us. If You click on a third party link, You will be directed to that third party's site. We strongly advise You to review the Privacy Policy of every site You visit.

We have no control over and assume no responsibility for the content, privacy policies or practices of any third party sites or services.

## Changes to this Privacy Policy

We may update Our Privacy Policy from time to time. We will notify You of any changes by posting the new Privacy Policy on this page.

We will let You know via email and/or a prominent notice on Our Service, prior to the change becoming effective and update the "Last updated" date at the top of this Privacy Policy.

You are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on this page.

## Contact Us

If you have any questions about this Privacy Policy, You can contact us:

- By visiting this page on our website: [github.com/willtheorangeguy/Chrome-File-Directory](github.com/willtheorangeguy/Chrome-File-Directory).
Loading

0 comments on commit 27240e5

Please sign in to comment.