From 5aaf9dea5c36d37f77e3d58029e6740196ecc5e2 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Nov 03 2012 02:52:48 +0000 Subject: Update `Repository/Convenctions/filenames.docbook' file. --- diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/filenames.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/filenames.docbook index 9cde7ba..c43fada 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/filenames.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/filenames.docbook @@ -1,23 +1,185 @@ - +
Repository File Names + +
+ Regular Files - Inside &TCAR;, file names are all written in lowercase (e.g., - 01-welcome.png, - splash.png, - anaconda_header.png, etc.) and directory - names are all written capitalized (e.g., Identity, Themes, Motifs) and sometimes in cammel - case (e.g., TreeFlower, - etc.). In the very specific case of repository documentation - entries, file names follow the directory naming convenction. - This is because they are documenting directories and that is - something we want to remark. So, to better describe what we - are documenting, documentation entries follow the name - convenction used by the item they document. + Inside &TCAR;, file names are always written in lowercase. + Digits (e.g., 0, 1, 2), hyphen (-), dot + (.) and low line (_) + characters are also accepted. In case you use hyphen and dot + characters, don't use them as first character in the file + name. - - + +
+ Files Written Correctly + + The following file names are written correctly: + + + + + 01-welcome.png + + + + + splash.png + + + + + anaconda_header.png + + + +
+ +
+ Files Written Incorrectly + + The following file names are written incorrectly: + + + + + 01-Welcome.png + + + + + -welcome.png + + + + + Splash.png + + + + + AnacondaHeader.png + + + +
+ +
+ Exceptions + + When you name files, consider the following exceptions: + + + + + In the very specific case of repository documentation entries + written in Texinfo format, file names follow the directory + structure naming convenction. This is because they are + documenting directories and that is something + we want to remark. So, to better describe what we are + documenting, files related to documentation entries follow the + name convenction used by the item they document. + + + + +
+ +
+ +
+ Symbolic Links + + Inside &TCAR;, symbolic link names follow the same + convenctions described in . + +
+ +
+ Directories + + Inside &TCAR;, directory names are all written capitalized and + sometimes in cammel case. Digits (e.g., 0, 1, 2), hyphen + (-), dot (.) and low line + (_) characters are also accepted. In case you + use hyphen and dot characters, don't use them as first + character in the directory name. + + +
+ Directories Written Correctly + + The following directory names are written correctly: + + + + + Identity, + Themes, + Motifs, + TreeFlower + + + + + Tcar-ug + + + + + 0.0.1, 0.0.1-35 + + + +
+ +
+ Directories Written Incorrectly + + The following directory names are written incorrectly: + + + + + identitY, + theMes, + MOTIFS, + treeFlower + + + + + tcar-ug + + + + + .0.1, .0.1-35 + + + +
+ +
+ Exceptions + + When you name directories, consider the following exceptions: + + + + + No one so far. + + + +
+ +
+ +