Cleanup of /common/ #2

Closed
opened 2022-07-02 10:36:36 -04:00 by manfromhuh · 8 comments
Contributor

The /common/ directory is currently a mess of unsorted files. It would help with develpopment to sort at least by file type.
Proposing adding the following folders:

  • JS - /common/js/ - Stores all JavaScript files
  • PHP - /common/php/ - Stores all PHP files
  • CSS - /common/css/ - Stores all CSS files

For /common/prisim/ and other 3rd party libraries these could remain in their respective folders.

The `/common/` directory is currently a mess of unsorted files. It would help with develpopment to sort at least by file type. Proposing adding the following folders: * JS - `/common/js/` - Stores all JavaScript files * PHP - `/common/php/` - Stores all PHP files * CSS - `/common/css/` - Stores all CSS files For `/common/prisim/` and other 3rd party libraries these could remain in their respective folders.
Author
Contributor

There are also several files that don't seem to be used anywhere on the site. These should be removed as part of the cleanup.

Examples

  • /common/gallery.css - The CSS contained in it is used to render the floating images but isn't loaded on pages that contain images and it's rules have been added to /common/styles.css.
  • /common/page_menu_table.php - Appears to have been used at one point to render directory listings as a table. The site currently uses /common/page_menu.php to do this function but the output is a <nav> menu.

There may be others.

There are also several files that don't seem to be used anywhere on the site. These should be removed as part of the cleanup. ## Examples * `/common/gallery.css` - The CSS contained in it is used to render the floating images but isn't loaded on pages that contain images and it's rules have been added to `/common/styles.css`. * `/common/page_menu_table.php` - Appears to have been used at one point to render directory listings as a table. The site currently uses `/common/page_menu.php` to do this function but the output is a `<nav>` menu. There may be others.
Author
Contributor

/common/gallery.js also apears to have been rolled into /common/page_format.js.
/common/font_size.js is an empty file.

`/common/gallery.js` also apears to have been rolled into `/common/page_format.js`. `/common/font_size.js` is an empty file.
Author
Contributor

/common/prisim/ should be renamed to /common/prism/ to reflect the proper spelling of the project.

`/common/prisim/` should be renamed to `/common/prism/` to reflect the proper spelling of the project.
20xd6 added this to the 1.0 Release milestone 2022-07-04 14:52:26 -04:00
20xd6 added the
enhancement
label 2022-07-04 15:03:16 -04:00
Author
Contributor

/common/markdown.php has been deprecated in favor of /common/md_read.php.

[`/common/markdown.php`](/git/20xd6/simple_blog/src/branch/master/common/markdown.php) has been deprecated in favor of [`/common/md_read.php`](/git/20xd6/simple_blog/src/branch/master/common/md_read.php).
Author
Contributor
[`/common/path_menu.php`](/git/20xd6/simple_blog/src/branch/master/common/path_menu.php) is empty.
Author
Contributor

Current list of empty or deprecated files

To be updated as more are found.

Empty

  • /common/font_size.js
  • /common/path_menu.php

Deprecated

  • /common/gallery.js
  • /common/gallery.css
  • /common/markdown.php
  • /common/page_menu_table.php
# Current list of empty or deprecated files To be updated as more are found. ## Empty - [ ] `/common/font_size.js` - [ ] `/common/path_menu.php` ## Deprecated - [ ] `/common/gallery.js` - [ ] `/common/gallery.css` - [ ] `/common/markdown.php` - [ ] `/common/page_menu_table.php`
Owner

Further deprecation or empty file cleanup will be moved to issue #7.

Further deprecation or empty file cleanup will be moved to issue #7.
Owner

This has been resolved as of PR #19 being merged into master.

This has been resolved as of PR #19 being merged into master.
20xd6 closed this issue 2022-07-26 11:32:27 -04:00
Sign in to join this conversation.
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: 20xd6/simple_blog#2
No description provided.