name: front class: middle center inverse # Naming Conventions _Keeping clutter to a minimum_ _Keeping things simple_ _Adding visual functionality_ --- ## Names of directories and files The main directory name structure is fixed. It has been designed to reduce clutter and at the same time allow non-techy people to read and understand it. --- ## File names ### Use of spaces Many of the file names are written with no spaces. Some people like to use the underscore "_" others the dash "-". In Boxxd "all" the spaces are filled "simply" with the dash. What you use is up to you. For reasons of future automation and reading we advise to make all names "space free". ### Use of capitals Please feel free to use long names and capitals in file names so that they can be easily understood. --- ### Use of attributes To indicate a file attribute such as language or that it is a template, just add the attribute to the file name. A couple of examples: * _Specification.en.md_ is a specification in English * _SlideShow-Template.html_ is a template which can be used for the slideshow ### .wiring The _.wiring_ directory is a special system directory: Many of the files will be in lower case, others with capitals. Please do not change anything within this directory to make it "look nice". --- ## Main file extensions Users will add their own files such as .pdf, .odt, etc. In Boxxd the main extensions which are used are: _.html_ is the file that will be shown in your browser. _.md_ is a text file using Markdown for the markup (i.e. formating instructions and for giving it structure). ### Visual tagging The _.tag_ is used as a visual indicator of some information to the user. An example is the _.tag_ files in the _Works_ subdirectories, or it might be the version of a software. These _.tag_ files will probably be empty i.e. 0 bytes. Please do not delete them. --- ## Functional extensions ### Media _.media.md_ is used to document the ownership of the media (i.e. image) file. ### Others _.toml_ is a special file holding the attributes describing a 'thing'. --- ## Dot files and directories Some files or directories will have a dot before them. Examples: * _.wiring_ * _.error-slideShow-not-being-loaded.md_ These files are mainly system files and are for scripts and automation. These type of files are not normally shown and it will depend on the configuration of your file browser if you see them or not. Please do not delete them (unless you know what you are doing). In some directories there is a informational file for the user (.Info-about-this-directory.md) which describes what the directory is used for. You can extend or delete this file. [More info here](info-about-directory-file.html). `