Skip to content

Directory structure

Nuno Luciano edited this page May 29, 2024 · 3 revisions

Menu Tree

The Tree-like is automatically generetad from the folders and files hierarchical structure. Public folder or root directory contains subfolders, which themselves may contain other subfolders. The result is a Menu Tree that represents directories (folders) and files and how they are nested and related to each other on your server. This might help you to organize and users to explore contents based on their relationships and categories.

This typical hierarchical folder structure example is made up of several components:

  • Root directory
    The root directory sits at the top of the tree, represented as a single node or level, serving as the starting point for the entire file system.

  • Parent directory
    Except for the root, each directory has a parent. The parent directory contains the current directory.

  • Subdirectories-child directories
    Below the root directory and parent directories are subdirectories (also called child directories). These branch out from the root and may contain further subdirectories or simply files. Each is represented as a branch or node extending from its parent directory.

  • Files
    The leaves of the directory tree represent individual files.

  • Hierarchy
    The folder hierarchy itself creates a structure that naturally resembles something like a tree.


💡 Choose a file structure that matches the scale and aims of your project.


Project-centric structure

A structure with a folder for each project and files organized into subfolders according to their types, such as documents and images.

flowchart TD
    B["Public"]
    B-->C[Project 1]
    B-->D[Project 2]
    B-->E[fa:fa-ban Project 3]
    E-->F(Subfolder-1)
    E-->G(fa:fa-camera-retro Subfolder-2)
    G-->H(Sub-subfolder)
Loading

Topic-based hierarchy

Through the folder flow, you can also let users discover a thematic and chronological hierarchy: general folders for broad categories subdivided into more specific topics.

Best practices for naming conventions, or a few important base principles on which you can build your own.

  • Determine a file naming convention
  • Limit file names, keep it short, usually less than 32 characters.
  • Avoid special characters.
  • Avoid ambiguity, be descriptive particularly with versioning e.g. -v2 not _final_final.
  • Keep names concise.
  • Underscores _ and camelCase fileName are the two most common delimiters, they are interoperable with nearly all operating systems and coding languages.
  • Hyphens - are also quite common, visually similar to an underscore, and easily handled by most operating systems.
  • Abreviations are helpful, but make sure you define them in a readme file.
  • Use context e.g. parent folders, to avoid redundant lengthy names.
  • Use only one way to format a date YYYY_MM_DD e.g. 2019_07_04 to automatically sort chronologically.
  • Similarly, always pre-pad smaller numbers with zeros in a sequence e.g. 0110 instead of 1, 2, … 10.

Chronological

The chronological approach has a number of benefits. It provides an overview of the sequential development of a certain topic or project, to clearly see the logical progression, and stages within the development.

timeline
    title History of Social Media Platform
    2002 : LinkedIn
    2004 : Facebook
         : Google
    2005 : Youtube
    2006 : Twitter
Loading

Customized views

You can customize your interaction in organized folders using the sidebar panel.

Download contents

You can also check the box for each folder or file you want to generate an archive and download.