From 6e7231bda11f7335100ae7fb38806beb52252dd1 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 09 2012 01:27:23 +0000 Subject: Update `trunk/Manuals/Tcar-ug/Repository/Workstation/config.docbook' file. --- diff --git a/Manuals/Tcar-ug/Repository/Workstation/config.docbook b/Manuals/Tcar-ug/Repository/Workstation/config.docbook index f395825..35b055a 100644 --- a/Manuals/Tcar-ug/Repository/Workstation/config.docbook +++ b/Manuals/Tcar-ug/Repository/Workstation/config.docbook @@ -53,7 +53,7 @@ - Different Absolute Paths + Different absolute paths Consider that you store your working copy under /home/john/Projects/artwork/ and @@ -71,7 +71,7 @@ - One Unique Absolute Path + One unique absolute path Another case would be that where you and I ourselves use one unique home directory (e.g., - Different Absolute Paths Through Dynamic Expansion + Different absolute paths through dynamic expansion Most of the absolute paths we use inside the working copy are made of two parts, one dynamic and one relative fixed. The @@ -110,28 +110,85 @@ + + Different absolute paths, dynamic expansion, symbolic + links, relative links, and environment variables + + + With this solution it is possible to store working copies of + &TCAR; on different locations inside the same workstation + without lose relation between files. Here we use the + TCAR_WORKDIR environment variable to set the location of the + working copy inside the workstation. Later the centos-art.sh + scripts uses this value as reference to determine where the + working copy is. This value is also the one used for dynamic + expansion inside design models and other similar files. In the + case of web projects where different components are required + to produce the final content, we create symbolic links between + them and use relative paths so it is possible to reuse them + and retain the relation between them in different contexts. + + + + For example, lets consider the organization of XHTML manuals + rendered from DocBook source files. When you render a DocBook + manual inside &TCAR; it creates XHTML files. This XHTML files + use images and common style sheets for better presentation. + Both of these images and styles components live outside the + XHTML structure so, in order to make them available + relatively to the XHTML structure, we created symbolic links + from the XHTML structure to the outside location where they + are in. The creation of symbolic links takes place + automatically when each DockBook manual is rendered through + centos-art.sh, which uses the value of + TCAR_WORKDIR environment variable as reference to determine + the absolute path of the working copy. + + + + Bacause absolute paths are no longer stored inside permanent + files and centos-art.sh script uses the + TCAR_WORKDIR environment variable to determine where the + working copy is stored in the workstation, it should be safe + to download working copies of &TCAR; anywhere in the + workstation. One just have to be sure that the value of + TCAR_WORKDIR environment variable does match the location of + the working copy you are using. + + + + Download Your Working Copy - As convenction, to use the &TCAR;, you must register the user - name centos in your workstation, do login with - it, and download the working copy from the central repository - using the following command: + In order to use &TCAR; you need to download a working copy + from the central repository into your workstation. To + download such working copy use the following command: - svn co https://projects.centos.org/svn/artwork /home/centos/Projects/artwork + svn co https://projects.centos.org/svn/artwork ~/ + + + This command will create your working copy inside your home + directory, specifically in a directory named artwork. Inside this directory + you will find all the files you need to work with inside + &TCAR;. If you want to have your working copy in a location + different to that one shown above, see . + The first time you download the working copy it contains no image files, nor documentation, or localized content inside it. This is because all the files provided in the working copy are source files (e.g., the files needed to produce other - files) and it is up to you the action of render them to - produce the final files (e.g., images and documentation) used - to implement &TCPCVI;. + files) and it is up to you to render them in order to produce + the final files (e.g., images and documentation) used to + implement &TCPCVI;. @@ -145,7 +202,7 @@ prepare functionality of centos-art.sh script. Inside centos-art.sh - script, all administrative task are invoked trough the + script, all administrative task are invoked through the sudo command. Thus, in order for the centos-art.sh script to perform administrative tasks, you need to update the @@ -157,17 +214,18 @@ At time of this writing the centos-art.sh script implements just one administrative task, that is package management. Nevertheless, in the future, other - administrative tasks might be included as well. + administrative tasks might be included as well (e.g., + installing themes locally from the working copy for testing + purposes.). To update the sudo's configuration, execute the visudo command as root. Later, uncoment the Cmnd_Alias related to - SOFTWARE and add a line for - centos username allowing software commands. This - configuration is illustrated in . + SOFTWARE and add a line for your username + allowing software commands. This configuration is illustrated + in . @@ -194,7 +252,7 @@ root ALL=(ALL) ALL ## Allow the centos user to run installation and management of ## software anywhere. -centos ALL=(ALL) SOFTWARE +al ALL=(ALL) SOFTWARE @@ -204,17 +262,17 @@ centos ALL=(ALL) SOFTWARE - Run Automation Tool + Run Preparation Tool - Once you've created the centos username, logged - in with it, downloaded a working copy from &TCAR; and - configured the sudo's configuration file, - run the prepare functionality of - centos-art.sh script to complete the - configuration process using the following command: + Once you've both downloaded a working copy from &TCAR; + and configured the sudo's configuration + file successfully, run the prepare + functionality of centos-art.sh script to + complete the configuration process using the following + command: - /home/centos/Projects/artwork/trunk/Scripts/Bash/centos-art.sh prepare + ~/artwork/trunk/Scripts/Bash/centos-art.sh prepare To know more about the prepare @@ -223,4 +281,69 @@ centos ALL=(ALL) SOFTWARE + + Changing Your Working Copy Default Path + + By default your working copy should be store in your home + directory, specifically in the location ~/artwork. This location may not + be the final location where you want to have your working copy + in situations where you are working on several projects at the + same time or you already have a define location to organize + your projects inside your home directory. Thus, you may need + to change the default location of your working copy to a more + appropriate location. + + + + The default path to your working copy is controlled by the + TCAR_WORKDIR environment variable. This + variable is firstly defined in your personal profile after + running the prepare functionality of + centos-art.sh script. So, to change the + path of your working copy correctly, do the following: + + + + + + Create the parent directory you will use to store your working + copy. For example: + mkdir -p ~/Projects/CentOS + + + + + Move the currently downloaded working copy from ~/artwork to + your new location. For example: + mv ~/artwork ~/Projects/CentOS/ + + + + + Edit ~/.bash_profile file to set the new + location (without trailing slash) of your working copy as value + of TCAR_WORKDIR environment variable. For example: + TCAR_WORKDIR=${HOME}/Projects/CentOS/artwork + + + + + Do log out from your active user's seesion and do log in again + so the environment changes take effect. Or just update the + current environment information by running the following + command: + . ~/.bash_profile + + + + + Update internal links by running the following command: + ${TCAR_WORKDIR}/trunk/Scripts/Bash/centos-art.sh prepare --links + + + + + +