Renamed LiveSupport to Campcaster, for ticket #1883
This commit is contained in:
parent
5124344b3c
commit
174f9798da
|
@ -7,7 +7,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,10 +18,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the autoconf configure file conventions for the
|
This document describes the autoconf configure file conventions for the
|
||||||
LiveSupport
|
Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file
|
href="fileConventions.html">file
|
||||||
conventions</a> in the LiveSupport
|
conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
Autoconf configure input files are processed by GNU <a
|
Autoconf configure input files are processed by GNU <a
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
|
|
||||||
|
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gp
|
||||||
|
|
||||||
|
|
||||||
<li>Location: $URL:
|
<li>Location: $URL:
|
||||||
svn+ssh://maroy@code.campware.org/home/svn/repo/livesupport/trunk/livesupport/doc/developmentEnvironment/buildEnvironment.html
|
svn+ssh://maroy@code.campware.org/home/svn/repo/campcaster/trunk/campcaster/doc/developmentEnvironment/buildEnvironment.html
|
||||||
$<br>
|
$<br>
|
||||||
|
|
||||||
|
|
||||||
|
@ -52,7 +52,7 @@ $<br>
|
||||||
|
|
||||||
|
|
||||||
This document describes the build environment for components of the
|
This document describes the build environment for components of the
|
||||||
LiveSupport project.<br>
|
Campcaster project.<br>
|
||||||
|
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,10 +18,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes C++ header file conventions for the
|
This document describes C++ header file conventions for the
|
||||||
LiveSupport
|
Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file
|
href="fileConventions.html">file
|
||||||
conventions</a> in the LiveSupport
|
conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
C++ header files are files containing declarations of structures,
|
C++ header files are files containing declarations of structures,
|
||||||
|
@ -32,7 +32,7 @@ based files, thus they should adhere to the <a
|
||||||
href="fileConventions.html#textConventions">generic text-based
|
href="fileConventions.html#textConventions">generic text-based
|
||||||
conventions</a>.<br>
|
conventions</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
The LiveSupport project uses a strong object oriented approach. Part of
|
The Campcaster project uses a strong object oriented approach. Part of
|
||||||
this approach is to group declarations of classes into their own files:
|
this approach is to group declarations of classes into their own files:
|
||||||
one header file and one source file for each class. Therefore each C++
|
one header file and one source file for each class. Therefore each C++
|
||||||
header file contains the declaration of exactly one C++ class, although
|
header file contains the declaration of exactly one C++ class, although
|
||||||
|
@ -84,27 +84,27 @@ For a header file that will be included with the line:<br>
|
||||||
<pre><code>#include "Foo.h"</code><br></pre>
|
<pre><code>#include "Foo.h"</code><br></pre>
|
||||||
the identity macro is defined as <code>Foo_h</code>. For a header file
|
the identity macro is defined as <code>Foo_h</code>. For a header file
|
||||||
that is expected to be included as:<br>
|
that is expected to be included as:<br>
|
||||||
<pre><code>#include "LiveSupport/Foo/Bar.h"<br></code></pre>
|
<pre><code>#include "Campcaster/Foo/Bar.h"<br></code></pre>
|
||||||
the identity macro is defined as <code>LiveSupport_Foo_Bar_h</code>.<br>
|
the identity macro is defined as <code>Campcaster_Foo_Bar_h</code>.<br>
|
||||||
<br>
|
<br>
|
||||||
After the identity macro, a preprocessor check is performed to see if
|
After the identity macro, a preprocessor check is performed to see if
|
||||||
the file is being processessed by a C++ compiler (and say not a C
|
the file is being processessed by a C++ compiler (and say not a C
|
||||||
compiler).<br>
|
compiler).<br>
|
||||||
<h3>Sample</h3>
|
<h3>Sample</h3>
|
||||||
A sample for a C++ header file header follows, where the file itself
|
A sample for a C++ header file header follows, where the file itself
|
||||||
would be expected to be included as <code>"LiveSupport/Foo/Bar.h"</code>.<br>
|
would be expected to be included as <code>"Campcaster/Foo/Bar.h"</code>.<br>
|
||||||
<br>
|
<br>
|
||||||
<pre>/*------------------------------------------------------------------------------<br><br> Copyright (c) 2004 Media Development Loan Fund<br> <br> This file is part of the Campcaster project.<br> http://campcaster.campware.org/<br> To report bugs, send an e-mail to bugs@campware.org<br> <br> Campcaster is free software; you can redistribute it and/or modify<br> it under the terms of the GNU General Public License as published by<br> the Free Software Foundation; either version 2 of the License, or<br> (at your option) any later version.<br> <br> Campcaster is distributed in the hope that it will be useful,<br> but WITHOUT ANY WARRANTY; without even the implied warranty of<br> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br> GNU General Public License for more details.<br> <br> You should have received a copy of the GNU General Public License<br> along with Campcaster; if not, write to the Free Software<br> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br> <br> <br> Author : $Author$<br> Version : $Revision$<br> Location : $URL$<br> <br>------------------------------------------------------------------------------*/<br>#ifndef LiveSupport_Foo_Bar_h<br>#define LiveSupport_Foo_Bar_h<br> <br>#ifndef __cplusplus<br>#error This is a C++ include file<br>#endif<br><br></pre>
|
<pre>/*------------------------------------------------------------------------------<br><br> Copyright (c) 2004 Media Development Loan Fund<br> <br> This file is part of the Campcaster project.<br> http://campcaster.campware.org/<br> To report bugs, send an e-mail to bugs@campware.org<br> <br> Campcaster is free software; you can redistribute it and/or modify<br> it under the terms of the GNU General Public License as published by<br> the Free Software Foundation; either version 2 of the License, or<br> (at your option) any later version.<br> <br> Campcaster is distributed in the hope that it will be useful,<br> but WITHOUT ANY WARRANTY; without even the implied warranty of<br> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br> GNU General Public License for more details.<br> <br> You should have received a copy of the GNU General Public License<br> along with Campcaster; if not, write to the Free Software<br> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br> <br> <br> Author : $Author$<br> Version : $Revision$<br> Location : $URL$<br> <br>------------------------------------------------------------------------------*/<br>#ifndef Campcaster_Foo_Bar_h<br>#define Campcaster_Foo_Bar_h<br> <br>#ifndef __cplusplus<br>#error This is a C++ include file<br>#endif<br><br></pre>
|
||||||
<h2>Include files & namespace <br>
|
<h2>Include files & namespace <br>
|
||||||
</h2>
|
</h2>
|
||||||
This section contains all the include files that the header file needs
|
This section contains all the include files that the header file needs
|
||||||
to include, plus namespace declarations. The include files are listed
|
to include, plus namespace declarations. The include files are listed
|
||||||
in a most generic to most specific order: firts system include files,
|
in a most generic to most specific order: firts system include files,
|
||||||
then other LiveSupport module include files, and finnally include files
|
then other Campcaster module include files, and finnally include files
|
||||||
from the same module / product are listed.<br>
|
from the same module / product are listed.<br>
|
||||||
<br>
|
<br>
|
||||||
After the includes, namespace definitions follow. Each LiveSupport
|
After the includes, namespace definitions follow. Each Campcaster
|
||||||
object is contained in its own namespace inside the <code>LiveSupport</code>
|
object is contained in its own namespace inside the <code>Campcaster</code>
|
||||||
namespace, thus this is a nested namespace declaration.<br>
|
namespace, thus this is a nested namespace declaration.<br>
|
||||||
<br>
|
<br>
|
||||||
After the namespace declarations, the namespaces used within the
|
After the namespace declarations, the namespaces used within the
|
||||||
|
@ -114,7 +114,7 @@ strictly within the namespace declaration clauses, so that they only
|
||||||
take effect within the header file, but not afterwards.<br>
|
take effect within the header file, but not afterwards.<br>
|
||||||
<h3>Sample</h3>
|
<h3>Sample</h3>
|
||||||
A sample include files & namespaces section follows.<br>
|
A sample include files & namespaces section follows.<br>
|
||||||
<pre>/* =============================================== include files & namespaces */<br><br>#ifdef HAVE_CONFIG_H<br>#include "configure.h"<br>#endif<br><br>#if HAVE_STDLIB_H<br>#include <stdlib.h><br>#else<br>#error need stdlib.h<br>#endif<br><br>#include <string><br><br><br>namespace LiveSupport {<br>namespace Foo {<br><br>using namespace LiveSupport::Core;<br><br></pre>
|
<pre>/* =============================================== include files & namespaces */<br><br>#ifdef HAVE_CONFIG_H<br>#include "configure.h"<br>#endif<br><br>#if HAVE_STDLIB_H<br>#include <stdlib.h><br>#else<br>#error need stdlib.h<br>#endif<br><br>#include <string><br><br><br>namespace Campcaster {<br>namespace Foo {<br><br>using namespace Campcaster::Core;<br><br></pre>
|
||||||
<h2>Constants</h2>
|
<h2>Constants</h2>
|
||||||
The constants section contains static constant values defined in the
|
The constants section contains static constant values defined in the
|
||||||
header file.
|
header file.
|
||||||
|
@ -189,7 +189,7 @@ identity macro #ifdef section opened in the header.<br>
|
||||||
<h3>Sample</h3>
|
<h3>Sample</h3>
|
||||||
A sample footer section follows.<br>
|
A sample footer section follows.<br>
|
||||||
<br>
|
<br>
|
||||||
<pre>} // namespace Foo<br>} // namespace LiveSupport<br><br>#endif // LiveSupport_Foo_Bar_h<br></pre>
|
<pre>} // namespace Foo<br>} // namespace Campcaster<br><br>#endif // Campcaster_Foo_Bar_h<br></pre>
|
||||||
<h1>Template</h1>
|
<h1>Template</h1>
|
||||||
See a <a href="templates/Bar.h">template
|
See a <a href="templates/Bar.h">template
|
||||||
C++ header file</a>. You may freely copy this
|
C++ header file</a>. You may freely copy this
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,10 +18,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes C++ source file conventions for the
|
This document describes C++ source file conventions for the
|
||||||
LiveSupport
|
Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file
|
href="fileConventions.html">file
|
||||||
conventions</a> in the LiveSupport
|
conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
C++ source files are files containing implementations of functions and
|
C++ source files are files containing implementations of functions and
|
||||||
|
@ -30,7 +30,7 @@ based files, thus they should adhere to the <a
|
||||||
href="fileConventions.html#textConventions">generic text-based
|
href="fileConventions.html#textConventions">generic text-based
|
||||||
conventions</a>.<br>
|
conventions</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
The LiveSupport project uses a strong object oriented approach. Part of
|
The Campcaster project uses a strong object oriented approach. Part of
|
||||||
this approach is to group implementations of classes into their own
|
this approach is to group implementations of classes into their own
|
||||||
files: one header file and one source file for each class. Therefore
|
files: one header file and one source file for each class. Therefore
|
||||||
each C++ source file contains implementation of exactly one C++ class,
|
each C++ source file contains implementation of exactly one C++ class,
|
||||||
|
@ -89,7 +89,7 @@ A sample for a C++ source file header follows.<br>
|
||||||
This section contains all the include files that the source file needs
|
This section contains all the include files that the source file needs
|
||||||
to include, plus namespace references. The include files are listed in
|
to include, plus namespace references. The include files are listed in
|
||||||
a most generic to most specific order: first system include files, then
|
a most generic to most specific order: first system include files, then
|
||||||
other LiveSupport module include files, and finally include files from
|
other Campcaster module include files, and finally include files from
|
||||||
the same module / product are listed. The last one is the header file
|
the same module / product are listed. The last one is the header file
|
||||||
for the class this source file implements.<br>
|
for the class this source file implements.<br>
|
||||||
<br>
|
<br>
|
||||||
|
@ -100,7 +100,7 @@ most specific, the last one being the namespace of the class this
|
||||||
source file implements.<br>
|
source file implements.<br>
|
||||||
<h3>Sample</h3>
|
<h3>Sample</h3>
|
||||||
A sample include files & namespaces section follows.<br>
|
A sample include files & namespaces section follows.<br>
|
||||||
<pre>/* =============================================== include files & namespaces */<br><br>#ifdef HAVE_CONFIG_H<br>#include "configure.h"<br>#endif<br><br>#if HAVE_STDLIB_H<br>#include <stdlib.h><br>#else<br>#error need stdlib.h<br>#endif<br><br>#include <string><br><br>#include <LiveSupport/Foo/Bar.h><br><br><br>using namespace LiveSupport::Core;<br>using namespace LiveSupport::Foo;<br><br></pre>
|
<pre>/* =============================================== include files & namespaces */<br><br>#ifdef HAVE_CONFIG_H<br>#include "configure.h"<br>#endif<br><br>#if HAVE_STDLIB_H<br>#include <stdlib.h><br>#else<br>#error need stdlib.h<br>#endif<br><br>#include <string><br><br>#include <Campcaster/Foo/Bar.h><br><br><br>using namespace Campcaster::Core;<br>using namespace Campcaster::Foo;<br><br></pre>
|
||||||
<h2>Local data structures<br>
|
<h2>Local data structures<br>
|
||||||
</h2>
|
</h2>
|
||||||
The constants section contains locally defined data structures, that
|
The constants section contains locally defined data structures, that
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
|
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
|
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gp
|
||||||
<li>Version: $Revision$</li>
|
<li>Version: $Revision$</li>
|
||||||
|
|
||||||
<li>Location: $URL:
|
<li>Location: $URL:
|
||||||
svn+ssh://maroy@code.campware.org/home/svn/repo/livesupport/trunk/livesupport/doc/developmentEnvironment/directoryStructure.html
|
svn+ssh://maroy@code.campware.org/home/svn/repo/campcaster/trunk/campcaster/doc/developmentEnvironment/directoryStructure.html
|
||||||
$<br>
|
$<br>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
@ -37,7 +37,7 @@ $<br>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
|
|
||||||
This document describes the directory structure used for all component
|
This document describes the directory structure used for all component
|
||||||
of the LiveSupport project.<br>
|
of the Campcaster project.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
|
|
||||||
|
@ -55,13 +55,13 @@ Hierarchy Standard</a>.<br>
|
||||||
|
|
||||||
<h1>Overall structure</h1>
|
<h1>Overall structure</h1>
|
||||||
|
|
||||||
The base livesupport directory contains all the special tools needed to
|
The base campcaster directory contains all the special tools needed to
|
||||||
build, test and run LiveSupport, along with all the source code that
|
build, test and run Campcaster, along with all the source code that
|
||||||
constitutes LiveSupport itself.<br>
|
constitutes Campcaster itself.<br>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
The self written part of LiveSupport project consists of re-usable
|
The self written part of Campcaster project consists of re-usable
|
||||||
modules, and products.
|
modules, and products.
|
||||||
Modules are components that do not execute by themselves, but have a
|
Modules are components that do not execute by themselves, but have a
|
||||||
useful, preferably generic functionality. Products are the executable
|
useful, preferably generic functionality. Products are the executable
|
||||||
|
@ -75,8 +75,8 @@ circular reference is not allowed.<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
Other needed parts of the directory structure are involved with
|
Other needed parts of the directory structure are involved with
|
||||||
external libraries LiveSupport depends on, and a running environment
|
external libraries Campcaster depends on, and a running environment
|
||||||
where LiveSupport can run.<br>
|
where Campcaster can run.<br>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
@ -85,7 +85,7 @@ The directory structure is organized in the following way:<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<code></code>
|
<code></code>
|
||||||
<pre>livesupport<br>|-- configure<br>|-- bin<br>|-- doc<br>|-- etc<br>|-- src<br>| |-- modules<br>| | |-- module1<br>| | |-- module2<br>| ...<br>| | `-- moduleN<br>| |-- products<br>| | |-- product1<br>| | |-- product2<br>| | ...<br>| | `-- productN<br>| `-- tools<br>| |-- tool1<br>| |-- tool2<br>| ...<br>| `-- tool3<br>|-- tmp<br>|-- usr<br>`-- var<br></pre>
|
<pre>campcaster<br>|-- configure<br>|-- bin<br>|-- doc<br>|-- etc<br>|-- src<br>| |-- modules<br>| | |-- module1<br>| | |-- module2<br>| ...<br>| | `-- moduleN<br>| |-- products<br>| | |-- product1<br>| | |-- product2<br>| | ...<br>| | `-- productN<br>| `-- tools<br>| |-- tool1<br>| |-- tool2<br>| ...<br>| `-- tool3<br>|-- tmp<br>|-- usr<br>`-- var<br></pre>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
@ -101,7 +101,7 @@ same module, it can be sure that it is located at <code>../../modules/moduleX</c
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
Furthermore, if a module or product is referencing the running
|
Furthermore, if a module or product is referencing the running
|
||||||
environment under <code>livesupport/usr</code>, it can also be sure
|
environment under <code>campcaster/usr</code>, it can also be sure
|
||||||
that it is located at <code>../../../usr</code> from either the module or
|
that it is located at <code>../../../usr</code> from either the module or
|
||||||
the product directory.<br>
|
the product directory.<br>
|
||||||
|
|
||||||
|
@ -118,7 +118,7 @@ no assumptions on the relative locations of other components.<br>
|
||||||
|
|
||||||
<h1>Top-level configure script</h1>
|
<h1>Top-level configure script</h1>
|
||||||
|
|
||||||
The top-level <code>configure</code> script takes care of <a href="http://www.gnu.org/software/autoconf/">autoconf</a>-style configuring the whole LiveSupport project. This involves running <code>configure</code> in all tool, module and product directories, and creating a top-level <code>Makefile</code>.<br>
|
The top-level <code>configure</code> script takes care of <a href="http://www.gnu.org/software/autoconf/">autoconf</a>-style configuring the whole Campcaster project. This involves running <code>configure</code> in all tool, module and product directories, and creating a top-level <code>Makefile</code>.<br>
|
||||||
<br>
|
<br>
|
||||||
The configure script is expected to run autoconf in case the
|
The configure script is expected to run autoconf in case the
|
||||||
autoconf-style environment has not yet been set up. This typically
|
autoconf-style environment has not yet been set up. This typically
|
||||||
|
@ -129,7 +129,7 @@ involves executing an autogen.sh script from the bin directory.<br>
|
||||||
<h1>Documentation directory</h1>
|
<h1>Documentation directory</h1>
|
||||||
|
|
||||||
The doc directory contains generic documentation with respect to the
|
The doc directory contains generic documentation with respect to the
|
||||||
whole LiveSupport project. Documentation pertaining to a module or
|
whole Campcaster project. Documentation pertaining to a module or
|
||||||
products should go under the modules' or products' directory,
|
products should go under the modules' or products' directory,
|
||||||
respectively.<br>
|
respectively.<br>
|
||||||
|
|
||||||
|
@ -146,7 +146,7 @@ Each module has the same directory structure, which is as follows:<br>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<pre>moduleX<br>|-- configure<br>|-- bin<br>|-- etc<br>|-- include<br>| `-- LiveSupport<br>| `-- ModuleX<br>|-- lib<br>|-- src<br>|-- tmp<br>`-- var<br></pre>
|
<pre>moduleX<br>|-- configure<br>|-- bin<br>|-- etc<br>|-- include<br>| `-- Campcaster<br>| `-- ModuleX<br>|-- lib<br>|-- src<br>|-- tmp<br>`-- var<br></pre>
|
||||||
|
|
||||||
<h4>configure</h4>
|
<h4>configure</h4>
|
||||||
|
|
||||||
|
@ -166,12 +166,12 @@ All configuration files go here.<br>
|
||||||
The public C/C++ header files for this module. The include files are
|
The public C/C++ header files for this module. The include files are
|
||||||
stored in a subdirectory that completely replicates the namespacing of
|
stored in a subdirectory that completely replicates the namespacing of
|
||||||
the module itself, in a case-sensitive manner. Thus a header file name <code>Foo.h</code>
|
the module itself, in a case-sensitive manner. Thus a header file name <code>Foo.h</code>
|
||||||
for <code>ModuleX</code> would be contained in the directory <code>include/LiveSupport/ModuleX/Foo.h</code>,
|
for <code>ModuleX</code> would be contained in the directory <code>include/Campcaster/ModuleX/Foo.h</code>,
|
||||||
and would be included with the line:<br>
|
and would be included with the line:<br>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<pre>#include "LiveSupport/ModuleX/Foo.h"<br></pre>
|
<pre>#include "Campcaster/ModuleX/Foo.h"<br></pre>
|
||||||
|
|
||||||
<h4>lib</h4>
|
<h4>lib</h4>
|
||||||
|
|
||||||
|
@ -180,9 +180,9 @@ by building the module. All external, third-party libraries used by
|
||||||
this module should be installed into the <code>../../../usr/lib</code>
|
this module should be installed into the <code>../../../usr/lib</code>
|
||||||
directory. The libraries are named resembling the full namespacing of
|
directory. The libraries are named resembling the full namespacing of
|
||||||
the module, but all lower cased. For example, the library for moduleX
|
the module, but all lower cased. For example, the library for moduleX
|
||||||
would be named <code>liblivesupport_modulex.so</code>, and thus would
|
would be named <code>libcampcaster_modulex.so</code>, and thus would
|
||||||
be linked to with the linker option <code>-L../../modules/moduleX/lib
|
be linked to with the linker option <code>-L../../modules/moduleX/lib
|
||||||
-llivesupport_modulex</code>.<br>
|
-lcampcaster_modulex</code>.<br>
|
||||||
|
|
||||||
<h4>src</h4>
|
<h4>src</h4>
|
||||||
|
|
||||||
|
@ -213,8 +213,8 @@ an <code>include</code> directory.<br>
|
||||||
<h1>Tools structure</h1>
|
<h1>Tools structure</h1>
|
||||||
|
|
||||||
The tools directory is an archive of tools and external libraries used
|
The tools directory is an archive of tools and external libraries used
|
||||||
for either building or running the LiveSupport system. These tools are
|
for either building or running the Campcaster system. These tools are
|
||||||
installable to the usr directory of the LiveSupport directory tree.<br>
|
installable to the usr directory of the Campcaster directory tree.<br>
|
||||||
|
|
||||||
Each tool has its own directory, where several versions of the same
|
Each tool has its own directory, where several versions of the same
|
||||||
tool may reside. Thus the generic directory structure is as follows:<br>
|
tool may reside. Thus the generic directory structure is as follows:<br>
|
||||||
|
@ -239,9 +239,9 @@ be contained in the <code>etc</code> directory.<br>
|
||||||
The usr directory is similar to the /usr system directory on UNIX
|
The usr directory is similar to the /usr system directory on UNIX
|
||||||
systems (see the <a href="http://www.pathname.com/fhs/">Filesystem
|
systems (see the <a href="http://www.pathname.com/fhs/">Filesystem
|
||||||
Hierarchy Standard</a>). This directory contains all the external tools
|
Hierarchy Standard</a>). This directory contains all the external tools
|
||||||
needed by either developing or running the LiveSupport system. This
|
needed by either developing or running the Campcaster system. This
|
||||||
directory is separate from the system /usr directory in order to
|
directory is separate from the system /usr directory in order to
|
||||||
facilitate changing the configuration for LiveSupport related libraries
|
facilitate changing the configuration for Campcaster related libraries
|
||||||
and tools in user space.<br>
|
and tools in user space.<br>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -19,7 +19,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the conventions used for files in the
|
This document describes the conventions used for files in the
|
||||||
LiveSupport project.<br>
|
Campcaster project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
To facilitate cooperation between multiple contributors, it is
|
To facilitate cooperation between multiple contributors, it is
|
||||||
advisable to have common file conventions, so as the result of
|
advisable to have common file conventions, so as the result of
|
||||||
|
@ -42,7 +42,7 @@ In general, all documents have the following structure:<br>
|
||||||
</h2>
|
</h2>
|
||||||
The header of the file holds:<br>
|
The header of the file holds:<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li>a reference to the LiveSupport project itself</li>
|
<li>a reference to the Campcaster project itself</li>
|
||||||
<li>copyright information</li>
|
<li>copyright information</li>
|
||||||
<li>reference to the license of the file</li>
|
<li>reference to the license of the file</li>
|
||||||
<li>the latest author of the file</li>
|
<li>the latest author of the file</li>
|
||||||
|
@ -72,7 +72,7 @@ nature of the file itself.<br>
|
||||||
<h2><a name="textConventions"></a>Generic text-based conventions</h2>
|
<h2><a name="textConventions"></a>Generic text-based conventions</h2>
|
||||||
The majority (if not) all sources files are text-based. As a general
|
The majority (if not) all sources files are text-based. As a general
|
||||||
rule, text-based files adhere to the following conventions in the
|
rule, text-based files adhere to the following conventions in the
|
||||||
LiveSupport project:<br>
|
Campcaster project:<br>
|
||||||
<h3>UTF-8</h3>
|
<h3>UTF-8</h3>
|
||||||
Whenever possible, the text files should be saved in the <a
|
Whenever possible, the text files should be saved in the <a
|
||||||
href="http://www.unicode.org/glossary/#UTF_8">UTF-8</a> character
|
href="http://www.unicode.org/glossary/#UTF_8">UTF-8</a> character
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,12 +18,12 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the HTML file conventions for the LiveSupport
|
This document describes the HTML file conventions for the Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file conventions</a> in the LiveSupport
|
href="fileConventions.html">file conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
HTML pages written as part of the LiveSupport documentation should
|
HTML pages written as part of the Campcaster documentation should
|
||||||
conform to either the <a href="http://www.w3.org/TR/html4/">HTML 4.01
|
conform to either the <a href="http://www.w3.org/TR/html4/">HTML 4.01
|
||||||
Transitional</a> or <a href="http://www.w3.org/TR/xhtml1/">XHTML 1.0
|
Transitional</a> or <a href="http://www.w3.org/TR/xhtml1/">XHTML 1.0
|
||||||
Transitional</a> specifications.<br>
|
Transitional</a> specifications.<br>
|
||||||
|
@ -59,7 +59,7 @@ element for the HTML page:<br>
|
||||||
This section holds the following specific text:<br>
|
This section holds the following specific text:<br>
|
||||||
<br>
|
<br>
|
||||||
<blockquote>This document is part of the <a
|
<blockquote>This document is part of the <a
|
||||||
href="http://livesupport.campware.org/">LiveSupport</a> project,
|
href="http://campcaster.campware.org/">Campcaster</a> project,
|
||||||
Copyright © 2004 <a href="http://www.mdlf.org/">Media Development Loan
|
Copyright © 2004 <a href="http://www.mdlf.org/">Media Development Loan
|
||||||
Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<title>LiveSupport development environment</title>
|
<title>Campcaster development environment</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@
|
||||||
|
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
|
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
|
||||||
|
@ -27,19 +27,19 @@ Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gp
|
||||||
<li>Version: $Revision$</li>
|
<li>Version: $Revision$</li>
|
||||||
|
|
||||||
<li>Location: $URL:
|
<li>Location: $URL:
|
||||||
svn+ssh://maroy@code.campware.org/home/svn/repo/livesupport/trunk/livesupport/doc/developmentEnvironment/index.html
|
svn+ssh://maroy@code.campware.org/home/svn/repo/campcaster/trunk/campcaster/doc/developmentEnvironment/index.html
|
||||||
$</li>
|
$</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
|
|
||||||
This document gives an overview of the LiveSupport development
|
This document gives an overview of the Campcaster development
|
||||||
environment.<br>
|
environment.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
|
|
||||||
The LiveSupport project defines a uniform development environment to
|
The Campcaster project defines a uniform development environment to
|
||||||
enhance collaboration of participants in the project. The following
|
enhance collaboration of participants in the project. The following
|
||||||
aspects of the environment are defined so far:<br>
|
aspects of the environment are defined so far:<br>
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
|
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
|
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ Development Loan Fund</a>, under the GNU <a href="http://www.gnu.org/licenses/gp
|
||||||
<li>Version: $Revision$</li>
|
<li>Version: $Revision$</li>
|
||||||
|
|
||||||
<li>Location: $URL:
|
<li>Location: $URL:
|
||||||
svn+ssh://maroy@code.campware.org/home/svn/repo/livesupport/trunk/livesupport/doc/developmentEnvironment/buildEnvironment.html
|
svn+ssh://maroy@code.campware.org/home/svn/repo/campcaster/trunk/campcaster/doc/developmentEnvironment/buildEnvironment.html
|
||||||
$<br>
|
$<br>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
@ -36,7 +36,7 @@ $<br>
|
||||||
|
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
|
|
||||||
This document describes the installation procedures used by the components of the LiveSupport project.<br>
|
This document describes the installation procedures used by the components of the Campcaster project.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
Component installation is a process more tricky than it seems at first.
|
Component installation is a process more tricky than it seems at first.
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,10 +18,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the Makefile file conventions for the
|
This document describes the Makefile file conventions for the
|
||||||
LiveSupport
|
Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file
|
href="fileConventions.html">file
|
||||||
conventions</a> in the LiveSupport
|
conventions</a> in the Campcaster
|
||||||
project. This document does not describe the mandatory targets for
|
project. This document does not describe the mandatory targets for
|
||||||
Makefiles, see the <a href="buildEnvironment.html">build environment</a>
|
Makefiles, see the <a href="buildEnvironment.html">build environment</a>
|
||||||
description for such details.<br>
|
description for such details.<br>
|
||||||
|
@ -81,12 +81,12 @@ directories or files change.<br>
|
||||||
No directories or external files may be directory referenced outside
|
No directories or external files may be directory referenced outside
|
||||||
this section.<br>
|
this section.<br>
|
||||||
<br>
|
<br>
|
||||||
When referencing other LiveSupport modules, typically the following
|
When referencing other Campcaster modules, typically the following
|
||||||
variables are defined for them:<br>
|
variables are defined for them:<br>
|
||||||
<pre><code>MODULEX_DIR = ${MODULES_DIR}/moduleX<br>MODULEX_INCLUDE_DIR = ${MODULEX_DIR}/include<br>MODULEX_LIB_DIR = ${MODULEX_DIR}/lib<br>MODULEX_LIB = livesupport_modulex<br></code></pre>
|
<pre><code>MODULEX_DIR = ${MODULES_DIR}/moduleX<br>MODULEX_INCLUDE_DIR = ${MODULEX_DIR}/include<br>MODULEX_LIB_DIR = ${MODULEX_DIR}/lib<br>MODULEX_LIB = campcaster_modulex<br></code></pre>
|
||||||
<h3>Sample</h3>
|
<h3>Sample</h3>
|
||||||
A sample directory and file definition section follows.<br>
|
A sample directory and file definition section follows.<br>
|
||||||
<pre>#-------------------------------------------------------------------------------<br># Basic directory and file definitions<br>#-------------------------------------------------------------------------------<br>BASE_DIR = .<br>DOC_DIR = ${BASE_DIR}/doc<br>DOXYGEN_DIR = ${DOC_DIR}/doxygen<br>ETC_DIR = ${BASE_DIR}/etc<br>SRC_DIR = ${BASE_DIR}/src<br>TMP_DIR = ${BASE_DIR}/tmp<br><br><br>USR_DIR = ${BASE_DIR}/../../usr<br>USR_INCLUDE_DIR = ${USR_DIR}/include<br>USR_LIB_DIR = ${USR_DIR}/lib<br>BOOST_INCLUDE_DIR = ${USR_INCLUDE_DIR}/boost-1_31<br>LIBXMLPP_INCLUDE_DIR = ${USR_INCLUDE_DIR}/libxml++-1.0<br><br>MODULES_DIR = ${BASE_DIR}/../../modules<br><br>HELLOLIB_DIR = ${MODULES_DIR}/hello<br>HELLOLIB_INCLUDE_DIR = ${HELLOLIB_DIR}/include<br>HELLOLIB_LIB_DIR = ${HELLOLIB_DIR}/lib<br>HELLOLIB_LIB = livesupport_hello<br><br>VPATH = ${SRC_DIR}<br><br>HELLO_EXE = ${TMP_DIR}/hello<br><br>DOXYGEN_CONFIG = ${ETC_DIR}/doxygen.config<br><br></pre>
|
<pre>#-------------------------------------------------------------------------------<br># Basic directory and file definitions<br>#-------------------------------------------------------------------------------<br>BASE_DIR = .<br>DOC_DIR = ${BASE_DIR}/doc<br>DOXYGEN_DIR = ${DOC_DIR}/doxygen<br>ETC_DIR = ${BASE_DIR}/etc<br>SRC_DIR = ${BASE_DIR}/src<br>TMP_DIR = ${BASE_DIR}/tmp<br><br><br>USR_DIR = ${BASE_DIR}/../../usr<br>USR_INCLUDE_DIR = ${USR_DIR}/include<br>USR_LIB_DIR = ${USR_DIR}/lib<br>BOOST_INCLUDE_DIR = ${USR_INCLUDE_DIR}/boost-1_31<br>LIBXMLPP_INCLUDE_DIR = ${USR_INCLUDE_DIR}/libxml++-1.0<br><br>MODULES_DIR = ${BASE_DIR}/../../modules<br><br>HELLOLIB_DIR = ${MODULES_DIR}/hello<br>HELLOLIB_INCLUDE_DIR = ${HELLOLIB_DIR}/include<br>HELLOLIB_LIB_DIR = ${HELLOLIB_DIR}/lib<br>HELLOLIB_LIB = campcaster_hello<br><br>VPATH = ${SRC_DIR}<br><br>HELLO_EXE = ${TMP_DIR}/hello<br><br>DOXYGEN_CONFIG = ${ETC_DIR}/doxygen.config<br><br></pre>
|
||||||
<h2>Configuration parameters</h2>
|
<h2>Configuration parameters</h2>
|
||||||
This section contains the parameters passed to the building tools
|
This section contains the parameters passed to the building tools
|
||||||
(compiler, linker, etc.) When invoking building tools, they should be
|
(compiler, linker, etc.) When invoking building tools, they should be
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,9 +18,9 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the PHP script file conventions for the LiveSupport
|
This document describes the PHP script file conventions for the Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file conventions</a> in the LiveSupport
|
href="fileConventions.html">file conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
PHP scripts are text-based files containing PHP class definitions and/or commands.<br/>
|
PHP scripts are text-based files containing PHP class definitions and/or commands.<br/>
|
||||||
|
@ -116,7 +116,7 @@ This section contains all the include files that the script needs
|
||||||
to include.
|
to include.
|
||||||
The include files are listed in
|
The include files are listed in
|
||||||
a most generic to most specific order: first PEAR classes, then
|
a most generic to most specific order: first PEAR classes, then
|
||||||
other LiveSupport module include files, and finally include files from
|
other Campcaster module include files, and finally include files from
|
||||||
the same module / product are listed.<br>
|
the same module / product are listed.<br>
|
||||||
Is much safer to use <code>include_once</code> or <code>require_once</code>, not the original versions
|
Is much safer to use <code>include_once</code> or <code>require_once</code>, not the original versions
|
||||||
of this statement.<br/>
|
of this statement.<br/>
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://campcaster.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,10 +18,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the shell script file conventions for the
|
This document describes the shell script file conventions for the
|
||||||
LiveSupport
|
Campcaster
|
||||||
project. See also the generic description of the <a
|
project. See also the generic description of the <a
|
||||||
href="fileConventions.html">file
|
href="fileConventions.html">file
|
||||||
conventions</a> in the LiveSupport
|
conventions</a> in the Campcaster
|
||||||
project.<br>
|
project.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
Shell scripts are text-based executable shell command files. As text
|
Shell scripts are text-based executable shell command files. As text
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport developer tools</title>
|
<title>Campcaster developer tools</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,9 +18,9 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document lists the development tools that are expected to be on a
|
This document lists the development tools that are expected to be on a
|
||||||
system that intends to compile and develop LiveSupport.<br>
|
system that intends to compile and develop Campcaster.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
LiveSupport expects a generic development environment on the system to
|
Campcaster expects a generic development environment on the system to
|
||||||
be built, which is basically a generic install of a POSIX-compliant
|
be built, which is basically a generic install of a POSIX-compliant
|
||||||
operating system, with a set of GNU development tools and some
|
operating system, with a set of GNU development tools and some
|
||||||
utilities.<br>
|
utilities.<br>
|
||||||
|
@ -91,10 +91,10 @@ system:<br>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>Recommended libraries</h2>
|
<h2>Recommended libraries</h2>
|
||||||
The following libraries are used by LiveSupport. If they are not found
|
The following libraries are used by Campcaster. If they are not found
|
||||||
on the system, LiveSupport will compile them from sources on its own.
|
on the system, Campcaster will compile them from sources on its own.
|
||||||
While having these libraries is not necessary, Compiling takes longer
|
While having these libraries is not necessary, Compiling takes longer
|
||||||
without them, and the generated LiveSupport directory will be larger as
|
without them, and the generated Campcaster directory will be larger as
|
||||||
well.<br>
|
well.<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="http://www.boost.org/">boost</a> >= 1.33.1</li>
|
<li><a href="http://www.boost.org/">boost</a> >= 1.33.1</li>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>Getting started with the LiveSupport development environment</title>
|
<title>Getting started with the Campcaster development environment</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -17,23 +17,23 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes how to set up the LiveSupport development
|
This document describes how to set up the Campcaster development
|
||||||
environment.<br>
|
environment.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
LiveSupport uses a well-defined <a
|
Campcaster uses a well-defined <a
|
||||||
href="developmentEnvironment/index.html">development environment</a>.
|
href="developmentEnvironment/index.html">development environment</a>.
|
||||||
Most of the LiveSupport-specific files are included in the version
|
Most of the Campcaster-specific files are included in the version
|
||||||
control system, but some preparation and setup has to be made on system
|
control system, but some preparation and setup has to be made on system
|
||||||
used to develop LiveSupport as well.<br>
|
used to develop Campcaster as well.<br>
|
||||||
<br>
|
<br>
|
||||||
There is a simplified and Ubuntu-centric version of this document in the
|
There is a simplified and Ubuntu-centric version of this document in the
|
||||||
<a href="http://code.campware.org/projects/livesupport/wiki/DevelopmentEnvironment">
|
<a href="http://code.campware.org/projects/campcaster/wiki/DevelopmentEnvironment">
|
||||||
LiveSupport Trac wiki</a>.
|
Campcaster Trac wiki</a>.
|
||||||
|
|
||||||
<h1>Steps<br>
|
<h1>Steps<br>
|
||||||
</h1>
|
</h1>
|
||||||
The following steps needed to be taken for setting up the LiveSupport
|
The following steps needed to be taken for setting up the Campcaster
|
||||||
development environment.<br>
|
development environment.<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li>install development tools<br>
|
<li>install development tools<br>
|
||||||
|
@ -42,25 +42,25 @@ development environment.<br>
|
||||||
<li>check out the sources</li>
|
<li>check out the sources</li>
|
||||||
<li>configure the environment<br>
|
<li>configure the environment<br>
|
||||||
</li>
|
</li>
|
||||||
<li>set up tools used by LiveSupport</li>
|
<li>set up tools used by Campcaster</li>
|
||||||
<li>personalize your development environment<br>
|
<li>personalize your development environment<br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2>Install development tools</h2>
|
<h2>Install development tools</h2>
|
||||||
Install all the tools needed for the development of LiveSupport. Please
|
Install all the tools needed for the development of Campcaster. Please
|
||||||
see the <a href="developmentTools.html">development tools</a> document
|
see the <a href="developmentTools.html">development tools</a> document
|
||||||
for a list of tools needed.<br>
|
for a list of tools needed.<br>
|
||||||
<h2>Set up additional system resources</h2>
|
<h2>Set up additional system resources</h2>
|
||||||
The LiveSupport development environment uses some system resources,
|
The Campcaster development environment uses some system resources,
|
||||||
that are not reasonable to include in the environment itself.<br>
|
that are not reasonable to include in the environment itself.<br>
|
||||||
<h3>Test database<br>
|
<h3>Test database<br>
|
||||||
</h3>
|
</h3>
|
||||||
One such
|
One such
|
||||||
resource is an ODBC datasource to a test database. This
|
resource is an ODBC datasource to a test database. This
|
||||||
database has to be accessible for executing the test suites and
|
database has to be accessible for executing the test suites and
|
||||||
applications within the LiveSupport development environment.<br>
|
applications within the Campcaster development environment.<br>
|
||||||
<br>
|
<br>
|
||||||
First, LiveSupport expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
First, Campcaster expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
||||||
database, and an ODBC
|
database, and an ODBC
|
||||||
Data Source accessible to it through <a href="http://www.unixodbc.org/">unixODBC</a>.
|
Data Source accessible to it through <a href="http://www.unixodbc.org/">unixODBC</a>.
|
||||||
Please refer to the documentation of these tools to set them up.<br>
|
Please refer to the documentation of these tools to set them up.<br>
|
||||||
|
@ -91,7 +91,7 @@ restart the postgresql daemon.<br>
|
||||||
|
|
||||||
<h3>Web server<br>
|
<h3>Web server<br>
|
||||||
</h3>
|
</h3>
|
||||||
Second, LiveSupport expects:
|
Second, Campcaster expects:
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="http://httpd.apache.org/">Apache</a> httpd server
|
<li><a href="http://httpd.apache.org/">Apache</a> httpd server
|
||||||
running on the development computer</li>
|
running on the development computer</li>
|
||||||
|
@ -119,26 +119,26 @@ apache, and change the <code>AllowOverride</code> directive in the
|
||||||
<br><br>
|
<br><br>
|
||||||
|
|
||||||
<h2>Check out the sources</h2>
|
<h2>Check out the sources</h2>
|
||||||
The LiveSupport development directory tree can be accessed anonymously via
|
The Campcaster development directory tree can be accessed anonymously via
|
||||||
<a href="http://subversion.tigris.org/">Subversion</a>, at
|
<a href="http://subversion.tigris.org/">Subversion</a>, at
|
||||||
<code>svn+ssh://code.campware.org/home/svn/repo/livesupport/trunk/livesupport</code>.
|
<code>svn+ssh://code.campware.org/home/svn/repo/campcaster/trunk/campcaster</code>.
|
||||||
The following Subversion command
|
The following Subversion command
|
||||||
would check out the development tree:<br><br>
|
would check out the development tree:<br><br>
|
||||||
<pre><code>svn checkout svn+ssh://code.campware.org/home/svn/repo/livesupport/trunk/livesupport</code></pre><br>
|
<pre><code>svn checkout svn+ssh://code.campware.org/home/svn/repo/campcaster/trunk/campcaster</code></pre><br>
|
||||||
This will check out and create the LiveSupport development <a
|
This will check out and create the Campcaster development <a
|
||||||
href="developmentEnvironment/directoryStructure.html">directory
|
href="developmentEnvironment/directoryStructure.html">directory
|
||||||
structure</a>.<br>
|
structure</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<h2>Configure the environment</h2>
|
<h2>Configure the environment</h2>
|
||||||
First, you need to create the database and ODBC data source used by
|
First, you need to create the database and ODBC data source used by
|
||||||
LiveSupport. This is done most easily by running the script
|
Campcaster. This is done most easily by running the script
|
||||||
<code>livesupport/bin/user_setup_db.sh</code>.
|
<code>campcaster/bin/user_setup_db.sh</code>.
|
||||||
Run the scripts as root, and provide your user name with the
|
Run the scripts as root, and provide your user name with the
|
||||||
<code>--user</code> option:
|
<code>--user</code> option:
|
||||||
|
|
||||||
<pre><code>
|
<pre><code>
|
||||||
cd livesupport
|
cd campcaster
|
||||||
sudo ./bin/user_setup_db.sh --user=<ls_developer_user>
|
sudo ./bin/user_setup_db.sh --user=<ls_developer_user>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<br>
|
<br>
|
||||||
|
@ -147,7 +147,7 @@ The script will set up the following resources:<br>
|
||||||
<li>a PostgreSQL user named <code>test</code> with the password
|
<li>a PostgreSQL user named <code>test</code> with the password
|
||||||
<code>test</code> (if it does not exist)</li>
|
<code>test</code> (if it does not exist)</li>
|
||||||
<li>a PostgreSQL database named
|
<li>a PostgreSQL database named
|
||||||
<code>LiveSupport-<ls_developer_user></code></li>
|
<code>Campcaster-<ls_developer_user></code></li>
|
||||||
<li>an ODBC data source of the same name, with user name
|
<li>an ODBC data source of the same name, with user name
|
||||||
and password <code>test</code></li>
|
and password <code>test</code></li>
|
||||||
</li>
|
</li>
|
||||||
|
@ -157,27 +157,27 @@ The script will set up the following resources:<br>
|
||||||
Next (and last), you compile the code and set up the configuration files.
|
Next (and last), you compile the code and set up the configuration files.
|
||||||
Both are done by the script
|
Both are done by the script
|
||||||
<pre><code>
|
<pre><code>
|
||||||
cd livesupport
|
cd campcaster
|
||||||
./bin/setupDevelopmentEnvironment.sh --apache-group=<apache_group>
|
./bin/setupDevelopmentEnvironment.sh --apache-group=<apache_group>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<br>
|
<br>
|
||||||
This script will set up the libraries used by LiveSupport (by compiling
|
This script will set up the libraries used by Campcaster (by compiling
|
||||||
and installing them under livesupport/usr), and set up the development
|
and installing them under campcaster/usr), and set up the development
|
||||||
environment for all LiveSupport modules.<br>
|
environment for all Campcaster modules.<br>
|
||||||
<br>
|
<br>
|
||||||
It will also create your personalized configuration files under
|
It will also create your personalized configuration files under
|
||||||
<code>~/.livesupport</code>, make certain directories writable for Apache
|
<code>~/.campcaster</code>, make certain directories writable for Apache
|
||||||
(this is where we need the current user to be a member of the
|
(this is where we need the current user to be a member of the
|
||||||
<code>apache</code> group), define a user-specific port for the scheduler
|
<code>apache</code> group), define a user-specific port for the scheduler
|
||||||
daemon, and create a symlink in <code>~/public_html/</code> to the PHP
|
daemon, and create a symlink in <code>~/public_html/</code> to the PHP
|
||||||
entry points.<br>
|
entry points.<br>
|
||||||
<br>
|
<br>
|
||||||
After running the above script, the livesupport development environment
|
After running the above script, the campcaster development environment
|
||||||
for the current user will be unique on the system, and will not
|
for the current user will be unique on the system, and will not
|
||||||
conflict with resources used by other developers. For example, the
|
conflict with resources used by other developers. For example, the
|
||||||
LiveSupport HTML user interface for the user will be reachable at:<br>
|
Campcaster HTML user interface for the user will be reachable at:<br>
|
||||||
<pre><code>
|
<pre><code>
|
||||||
http://localhost/~<ls_developer_user>/livesupport/htmlUI/var
|
http://localhost/~<ls_developer_user>/campcaster/htmlUI/var
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
@ -191,11 +191,11 @@ the commands in <code>setupDevelopmentEnvironment</code> up to, and not
|
||||||
including, the call to <code>user_setup.sh</code>; and manually execute
|
including, the call to <code>user_setup.sh</code>; and manually execute
|
||||||
the "Setup storage server" and "Setup directory permissions" portions
|
the "Setup storage server" and "Setup directory permissions" portions
|
||||||
of the <code>user_setup.sh</code> script. Finally, create a symlink
|
of the <code>user_setup.sh</code> script. Finally, create a symlink
|
||||||
<code>livesupport</code> in the root data directory of the Apache server
|
<code>campcaster</code> in the root data directory of the Apache server
|
||||||
which points to <code>livesupport/src/modules/</code>.
|
which points to <code>campcaster/src/modules/</code>.
|
||||||
The address of the HTML interface will now be<br>
|
The address of the HTML interface will now be<br>
|
||||||
<pre><code>
|
<pre><code>
|
||||||
http://localhost/livesupport/htmlUI/var
|
http://localhost/campcaster/htmlUI/var
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<br>
|
<br>
|
||||||
After this, the development environment should work, using the default
|
After this, the development environment should work, using the default
|
||||||
|
@ -205,7 +205,7 @@ out of date or incomplete.<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<h1>Ready to roll</h1>
|
<h1>Ready to roll</h1>
|
||||||
With the above steps completed, the LiveSupport modules and products
|
With the above steps completed, the Campcaster modules and products
|
||||||
are ready to be compiled and developed further. Have fun!<br>
|
are ready to be compiled and developed further. Have fun!<br>
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
<html><head><title>final designs : livesupport</title></head>
|
<html><head><title>final designs : campcaster</title></head>
|
||||||
<body>
|
<body>
|
||||||
<a href="livemode.gif" target="100%">master palette, live mode, cue, history, scratchpad and xfader</a><br>
|
<a href="livemode.gif" target="100%">master palette, live mode, cue, history, scratchpad and xfader</a><br>
|
||||||
<a href="advancedsearch.gif" target="100%">advanced search</a><br>
|
<a href="advancedsearch.gif" target="100%">advanced search</a><br>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport developer documentation</title>
|
<title>Campcaster developer documentation</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -17,10 +17,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document collects LiveSupport developer documentation, both
|
This document collects Campcaster developer documentation, both
|
||||||
generated and handwritten.<br>
|
generated and handwritten.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
The links below provide useful documentation for the LiveSupport
|
The links below provide useful documentation for the Campcaster
|
||||||
developer.<br>
|
developer.<br>
|
||||||
<h1>Static documentation<br>
|
<h1>Static documentation<br>
|
||||||
</h1>
|
</h1>
|
||||||
|
@ -32,11 +32,11 @@ developer.<br>
|
||||||
<h2>Developer documentation</h2>
|
<h2>Developer documentation</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="gettingStarted.html">getting started</a> with
|
<li><a href="gettingStarted.html">getting started</a> with
|
||||||
LiveSupport development</li>
|
Campcaster development</li>
|
||||||
<li><a href="developmentTools.html">development tools</a> needed to
|
<li><a href="developmentTools.html">development tools</a> needed to
|
||||||
compile LiveSupport<br>
|
compile Campcaster<br>
|
||||||
</li>
|
</li>
|
||||||
<li>LiveSupport <a href="developmentEnvironment/index.html">development
|
<li>Campcaster <a href="developmentEnvironment/index.html">development
|
||||||
environment</a></li>
|
environment</a></li>
|
||||||
<li>UML <a href="model/index.html">model</a></li>
|
<li>UML <a href="model/index.html">model</a></li>
|
||||||
<li><a href="install.html">installation instructions</a></li>
|
<li><a href="install.html">installation instructions</a></li>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport installation documentation</title>
|
<title>Campcaster installation documentation</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -17,41 +17,41 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes how to compile and install LiveSupport on your
|
This document describes how to compile and install Campcaster on your
|
||||||
system.<br>
|
system.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
LiveSupport has an installation procedure to make sure LiveSupport will
|
Campcaster has an installation procedure to make sure Campcaster will
|
||||||
work properly on your system. This procedure consists of the following
|
work properly on your system. This procedure consists of the following
|
||||||
steps:<br>
|
steps:<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li>installing required compilation tools</li>
|
<li>installing required compilation tools</li>
|
||||||
<li>installing and configuring required external services</li>
|
<li>installing and configuring required external services</li>
|
||||||
<li>obtaining LiveSupport sources</li>
|
<li>obtaining Campcaster sources</li>
|
||||||
<li>compiling LiveSupport</li>
|
<li>compiling Campcaster</li>
|
||||||
<li>installing LiveSupport</li>
|
<li>installing Campcaster</li>
|
||||||
<li>try it out</li>
|
<li>try it out</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2>For the impatient</h2>
|
<h2>For the impatient</h2>
|
||||||
Those who think they know everything, the quick steps to install
|
Those who think they know everything, the quick steps to install
|
||||||
LiveSupport are the following. (To run <code>make</code>, you need write
|
Campcaster are the following. (To run <code>make</code>, you need write
|
||||||
permissions in the <code>prefix</code> directory; to run
|
permissions in the <code>prefix</code> directory; to run
|
||||||
<code>make install</code> and <code>postInstallStation.sh</code>,
|
<code>make install</code> and <code>postInstallStation.sh</code>,
|
||||||
you need to be root.)
|
you need to be root.)
|
||||||
|
|
||||||
<pre><code>
|
<pre><code>
|
||||||
wget http://switch.dl.sourceforge.net/sourceforge/livesupport/livesupport-<version>.tar.bz2
|
wget http://switch.dl.sourceforge.net/sourceforge/campcaster/campcaster-<version>.tar.bz2
|
||||||
wget http://switch.dl.sourceforge.net/sourceforge/livesupport/livesupport-libraries-<version>.tar.bz2
|
wget http://switch.dl.sourceforge.net/sourceforge/campcaster/campcaster-libraries-<version>.tar.bz2
|
||||||
tar xfj livesupport-<version>.tar.bz2
|
tar xfj campcaster-<version>.tar.bz2
|
||||||
tar xfj livesupport-libraries-<version>.tar.bz2
|
tar xfj campcaster-libraries-<version>.tar.bz2
|
||||||
cd livesupport-<version>
|
cd campcaster-<version>
|
||||||
./configure --prefix=/usr/local/livesupport --with-apache-group=apache --with-www-docroot=/var/www
|
./configure --prefix=/usr/local/campcaster --with-apache-group=apache --with-www-docroot=/var/www
|
||||||
make
|
make
|
||||||
make install
|
make install
|
||||||
./bin/postInstallStation.sh -d /usr/local/livesupport -g apache -r /var/www
|
./bin/postInstallStation.sh -d /usr/local/campcaster -g apache -r /var/www
|
||||||
/usr/local/livesupport/bin/scheduler.sh start
|
/usr/local/campcaster/bin/scheduler.sh start
|
||||||
<br></code></pre>
|
<br></code></pre>
|
||||||
|
|
||||||
Then try the URL <code>http://localhost/livesupport/</code>
|
Then try the URL <code>http://localhost/campcaster/</code>
|
||||||
and log in using username: <code>root</code>, password: <code>q</code>.<br>
|
and log in using username: <code>root</code>, password: <code>q</code>.<br>
|
||||||
<br>
|
<br>
|
||||||
Everyone else, please read the lines below carefully.<br>
|
Everyone else, please read the lines below carefully.<br>
|
||||||
|
@ -63,11 +63,11 @@ them from the URLs listed, and compile them yourself (follow the instructions
|
||||||
included with each tool and library).<br>
|
included with each tool and library).<br>
|
||||||
|
|
||||||
<h1>Installing and configuring required external services</h1>
|
<h1>Installing and configuring required external services</h1>
|
||||||
LiveSupport depends on some external services to be able to run, most
|
Campcaster depends on some external services to be able to run, most
|
||||||
importantly a PHP-capable web server (we assume apache), and a database
|
importantly a PHP-capable web server (we assume apache), and a database
|
||||||
server (we assume PostgreSQL). <br>
|
server (we assume PostgreSQL). <br>
|
||||||
<h2>Database</h2>
|
<h2>Database</h2>
|
||||||
LiveSupport expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
Campcaster expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
||||||
database, version 7.4 or later, to be installed on your system. You will
|
database, version 7.4 or later, to be installed on your system. You will
|
||||||
also need a postgresql driver for unixODBC; this may be in the unixODBC
|
also need a postgresql driver for unixODBC; this may be in the unixODBC
|
||||||
package, or may need to be installed separately.<br>
|
package, or may need to be installed separately.<br>
|
||||||
|
@ -89,7 +89,7 @@ to include the following line, before any other lines starting with "host":<br>
|
||||||
These changes will make sure that the PostgreSQL database is accessible
|
These changes will make sure that the PostgreSQL database is accessible
|
||||||
via TCP/IP from localhost.<br>
|
via TCP/IP from localhost.<br>
|
||||||
<h2>Web server</h2>
|
<h2>Web server</h2>
|
||||||
LiveSupport expects an apache web server with PHP and some additional
|
Campcaster expects an apache web server with PHP and some additional
|
||||||
PHP modules installed. In particular:
|
PHP modules installed. In particular:
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="http://httpd.apache.org/">Apache</a> httpd server,
|
<li><a href="http://httpd.apache.org/">Apache</a> httpd server,
|
||||||
|
@ -128,32 +128,32 @@ or one other from <a href="http://packages.debian.org/cgi-bin/search_packages.pl
|
||||||
Then run "alsaconf" and check /proc/asound/cards again.
|
Then run "alsaconf" and check /proc/asound/cards again.
|
||||||
|
|
||||||
|
|
||||||
<h1>Obtaining LiveSupport sources</h1>
|
<h1>Obtaining Campcaster sources</h1>
|
||||||
LiveSupport sources come in two different tarballs:<br>
|
Campcaster sources come in two different tarballs:<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>livesupport-<version>.tar.bz2</code> - the
|
<li><code>campcaster-<version>.tar.bz2</code> - the
|
||||||
LiveSupport source files<code><br>
|
Campcaster source files<code><br>
|
||||||
</code></li>
|
</code></li>
|
||||||
<li><code>livesupport-libraries-<version>.tar.bz2</code> -
|
<li><code>campcaster-libraries-<version>.tar.bz2</code> -
|
||||||
external libraries used by LiveSupport<code><br>
|
external libraries used by Campcaster<code><br>
|
||||||
</code></li>
|
</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
Both files can be downloaded from <a
|
Both files can be downloaded from <a
|
||||||
href="http://sourceforge.net/projects/livesupport/"><code>http://sourceforge.net/projects/livesupport/</code></a>.
|
href="http://sourceforge.net/projects/campcaster/"><code>http://sourceforge.net/projects/campcaster/</code></a>.
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
After downloading the files, untar them in the same directory:<br>
|
After downloading the files, untar them in the same directory:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>tar xfj livesupport-<version>.tar.bz2<br>tar xfj livesupport-libraries-<version>.tar.bz2<br></code></pre>
|
<pre><code>tar xfj campcaster-<version>.tar.bz2<br>tar xfj campcaster-libraries-<version>.tar.bz2<br></code></pre>
|
||||||
<br>
|
<br>
|
||||||
which will create a <code>livesupport-<version></code>
|
which will create a <code>campcaster-<version></code>
|
||||||
directory, with all the required files to compile and install
|
directory, with all the required files to compile and install
|
||||||
LiveSupport.<br>
|
Campcaster.<br>
|
||||||
<h1>Compiling LiveSupport</h1>
|
<h1>Compiling Campcaster</h1>
|
||||||
To compile LiveSupport, enter the LiveSupport directory, and execute
|
To compile Campcaster, enter the Campcaster directory, and execute
|
||||||
the following commands:<br>
|
the following commands:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>cd livesupport-<version><br>./configure </code><code>--prefix=/usr/local/livesupport --with-apache-group=apache --with-www-docroot=/var/www<br></code><code>make<br></code></pre>
|
<pre><code>cd campcaster-<version><br>./configure </code><code>--prefix=/usr/local/campcaster --with-apache-group=apache --with-www-docroot=/var/www<br></code><code>make<br></code></pre>
|
||||||
<br>
|
<br>
|
||||||
Note that you need to have write permissions in the <code>prefix</code> directory
|
Note that you need to have write permissions in the <code>prefix</code> directory
|
||||||
when you run <code>make</code>.
|
when you run <code>make</code>.
|
||||||
|
@ -161,15 +161,15 @@ The configure options used above are the options most probably used:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code> --prefix=PREFIX install architecture-independent files in PREFIX<br> [/usr/local]</code></pre>
|
<pre><code> --prefix=PREFIX install architecture-independent files in PREFIX<br> [/usr/local]</code></pre>
|
||||||
The installation directory. Supply the previously
|
The installation directory. Supply the previously
|
||||||
decided LiveSupport installation directory here, <code><ls-installdir></code>
|
decided Campcaster installation directory here, <code><ls-installdir></code>
|
||||||
(as mentioned above). A sensible value to use here is <code>/usr/local/livesupport</code>.<br>
|
(as mentioned above). A sensible value to use here is <code>/usr/local/campcaster</code>.<br>
|
||||||
<pre><code><br> --with-apache-group use apache running in the specified group (apache)<br><br></code></pre>
|
<pre><code><br> --with-apache-group use apache running in the specified group (apache)<br><br></code></pre>
|
||||||
The user group the apache web server daemon runs at (see the section
|
The user group the apache web server daemon runs at (see the section
|
||||||
above on installing apache). Supply the <code><apache-group></code>
|
above on installing apache). Supply the <code><apache-group></code>
|
||||||
value here, as mentioned above, which is usually either <code>apache</code>
|
value here, as mentioned above, which is usually either <code>apache</code>
|
||||||
or <code>www-data</code>.<br>
|
or <code>www-data</code>.<br>
|
||||||
<br>
|
<br>
|
||||||
<pre> --with-www-docroot deploy LiveSupport under the specified docroot<br> (/var/www)<br><br></pre>
|
<pre> --with-www-docroot deploy Campcaster under the specified docroot<br> (/var/www)<br><br></pre>
|
||||||
The document root of your apache installation (see the section above on
|
The document root of your apache installation (see the section above on
|
||||||
installing apache). Supply the <code><www-root></code>
|
installing apache). Supply the <code><www-root></code>
|
||||||
value here, as mentioned above, which is usually <code>/var/www</code>
|
value here, as mentioned above, which is usually <code>/var/www</code>
|
||||||
|
@ -182,39 +182,39 @@ movie, relax,
|
||||||
etc.<br>
|
etc.<br>
|
||||||
<br>
|
<br>
|
||||||
If you want the installation script to create the database tables used
|
If you want the installation script to create the database tables used
|
||||||
by LiveSupport, consider using the following configure options:<br>
|
by Campcaster, consider using the following configure options:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre> --with-create-database specify whether the LiveSupport database and database<br> user should be created (no)<br> --with-create-odbc-data-source<br> specify whether the ODBC data source for LiveSupport<br> should be created (no)<br> --with-init-database specify whether the LiveSupport database tables<br> should be initialized (no)<br> --with-configure-apache specify whether apache should be configured for<br> LiveSupport through its conf.d directory (no)<br><br><br></pre>
|
<pre> --with-create-database specify whether the Campcaster database and database<br> user should be created (no)<br> --with-create-odbc-data-source<br> specify whether the ODBC data source for Campcaster<br> should be created (no)<br> --with-init-database specify whether the Campcaster database tables<br> should be initialized (no)<br> --with-configure-apache specify whether apache should be configured for<br> Campcaster through its conf.d directory (no)<br><br><br></pre>
|
||||||
For a full list of options, see <code>./configure --help</code><br>
|
For a full list of options, see <code>./configure --help</code><br>
|
||||||
<h1>Installing LiveSupport<br>
|
<h1>Installing Campcaster<br>
|
||||||
</h1>
|
</h1>
|
||||||
After a successful compilation, to install LiveSupport, you can install
|
After a successful compilation, to install Campcaster, you can install
|
||||||
LiveSupport by typing:<br>
|
Campcaster by typing:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>make install</code><br></pre>
|
<pre><code>make install</code><br></pre>
|
||||||
<br>
|
<br>
|
||||||
This will install LiveSupport into the directory specified to the
|
This will install Campcaster into the directory specified to the
|
||||||
configure script. It will also create necessary database tables,
|
configure script. It will also create necessary database tables,
|
||||||
depending on the invocation of the configure script. You need to run
|
depending on the invocation of the configure script. You need to run
|
||||||
<code>make install</code> as root.<br>
|
<code>make install</code> as root.<br>
|
||||||
<br>
|
<br>
|
||||||
<h1>Try it out</h1>
|
<h1>Try it out</h1>
|
||||||
After a successful installation, the LiveSupport scheduler has to be
|
After a successful installation, the Campcaster scheduler has to be
|
||||||
started. The scheduler has a System V runlevel-style startup script,
|
started. The scheduler has a System V runlevel-style startup script,
|
||||||
under <ls-installdir>/bin/scheduler.sh. To start the scheduler,
|
under <ls-installdir>/bin/scheduler.sh. To start the scheduler,
|
||||||
simply invoke:<br>
|
simply invoke:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code><ls-installdir>/bin/scheduler.sh start</code><br></pre>
|
<pre><code><ls-installdir>/bin/scheduler.sh start</code><br></pre>
|
||||||
<br>
|
<br>
|
||||||
The only thing left to do is to try out the LiveSupport web interface
|
The only thing left to do is to try out the Campcaster web interface
|
||||||
or the GUI application.<br>
|
or the GUI application.<br>
|
||||||
<br>
|
<br>
|
||||||
For the web interface, point your browser to the following URL: <code>http://<yourhost>/livesupport/</code>
|
For the web interface, point your browser to the following URL: <code>http://<yourhost>/campcaster/</code>
|
||||||
.<br>
|
.<br>
|
||||||
<br>
|
<br>
|
||||||
The GUI application can be started by issuing the following command:<br>
|
The GUI application can be started by issuing the following command:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code><ls-installdir>/bin/gLiveSupport.sh</code><br></pre>
|
<pre><code><ls-installdir>/bin/campcaster-studio.sh</code><br></pre>
|
||||||
<br>
|
<br>
|
||||||
For your first login, use the following values:<br>
|
For your first login, use the following values:<br>
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
<H1 CLASS="western"><FONT SIZE=4 STYLE="font-size: 16pt"><B>1.0 LS
|
<H1 CLASS="western"><FONT SIZE=4 STYLE="font-size: 16pt"><B>1.0 LS
|
||||||
Studio: A live radio show assistant</B></FONT></H1>
|
Studio: A live radio show assistant</B></FONT></H1>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">Live Support Studio is
|
<P CLASS="western" STYLE="margin-bottom: 0in">Live Support Studio is
|
||||||
the part of LiveSupport that completely does the on air playback
|
the part of Campcaster that completely does the on air playback
|
||||||
function inside a radio station's live studio but also includes all
|
function inside a radio station's live studio but also includes all
|
||||||
known automation elements.</P>
|
known automation elements.</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
|
@ -52,7 +52,7 @@ search criteria to the smallest search details.</P>
|
||||||
<P LANG="" CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P LANG="" CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><FONT SIZE=2 STYLE="font-size: 11pt"><I><B>Note:</B>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><FONT SIZE=2 STYLE="font-size: 11pt"><I><B>Note:</B>
|
||||||
LiveSupport Studio is not software for dynamic reduction
|
Campcaster Studio is not software for dynamic reduction
|
||||||
equalization or audio signal post processing - it doesn’t make
|
equalization or audio signal post processing - it doesn’t make
|
||||||
any major dynamic signal improvement.</I></FONT></P>
|
any major dynamic signal improvement.</I></FONT></P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
|
@ -65,7 +65,7 @@ tool (dynamic compression, DeEsser, level maximizing) for pseudo
|
||||||
acoustic improvements of the sound spectrum and listening impression.</FONT></I></P>
|
acoustic improvements of the sound spectrum and listening impression.</FONT></I></P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">LiveSupport Studio is
|
<P CLASS="western" STYLE="margin-bottom: 0in">Campcaster Studio is
|
||||||
intended to be used on an independent playback machine that has two
|
intended to be used on an independent playback machine that has two
|
||||||
working modes:</P>
|
working modes:</P>
|
||||||
<UL>
|
<UL>
|
||||||
|
@ -128,7 +128,7 @@ song</U></B>.</I></P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><FONT SIZE=4><I><FONT SIZE=3>Note:
|
<P CLASS="western" STYLE="margin-bottom: 0in"><FONT SIZE=4><I><FONT SIZE=3>Note:
|
||||||
Live Automatic mode is currently the only mode LS Studio has. Changes
|
Live Automatic mode is currently the only mode LS Studio has. Changes
|
||||||
take place frequently<B>, </B><SPAN STYLE="font-weight: medium">so
|
take place frequently<B>, </B><SPAN STYLE="font-weight: medium">so
|
||||||
check the LiveSupport homepage at </SPAN></FONT></I><A HREF="http://livesupport.campware.org/"><SPAN STYLE="font-weight: medium"><I><FONT SIZE=3>http://livesupport.campware.org</FONT></I></SPAN></A><SPAN STYLE="font-weight: medium"><I><FONT SIZE=3>
|
check the Campcaster homepage at </SPAN></FONT></I><A HREF="http://campcaster.campware.org/"><SPAN STYLE="font-weight: medium"><I><FONT SIZE=3>http://campcaster.campware.org</FONT></I></SPAN></A><SPAN STYLE="font-weight: medium"><I><FONT SIZE=3>
|
||||||
often. </FONT></I></SPAN></FONT>
|
often. </FONT></I></SPAN></FONT>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
|
@ -201,17 +201,17 @@ next song</U></B>.</I></P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<H2 CLASS="western"><FONT SIZE=4 STYLE="font-size: 16pt"><B>1.1
|
<H2 CLASS="western"><FONT SIZE=4 STYLE="font-size: 16pt"><B>1.1
|
||||||
Accessing LiveSupport Studio</B></FONT></H2>
|
Accessing Campcaster Studio</B></FONT></H2>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">When starting the
|
<P CLASS="western" STYLE="margin-bottom: 0in">When starting the
|
||||||
computer with LiveSupport installed from the demo/install CD - you
|
computer with Campcaster installed from the demo/install CD - you
|
||||||
will find the LS Studio icon on the desktop.
|
will find the LS Studio icon on the desktop.
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">After starting the
|
<P CLASS="western" STYLE="margin-bottom: 0in">After starting the
|
||||||
LiveSupport application on your studio machine, the Master Panel will
|
Campcaster application on your studio machine, the Master Panel will
|
||||||
appear, allowing you to login into the system and giving you
|
appear, allowing you to login into the system and giving you
|
||||||
essential information about the station time and logo as well as what
|
essential information about the station time and logo as well as what
|
||||||
is currently in the program.</P>
|
is currently in the program.</P>
|
||||||
|
@ -222,7 +222,7 @@ is currently in the program.</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">When starting
|
<P CLASS="western" STYLE="margin-bottom: 0in">When starting
|
||||||
LiveSupport Studio, the Master Panel appears in the upper part of the
|
Campcaster Studio, the Master Panel appears in the upper part of the
|
||||||
screen, remaining on the screen as your friendly assistant the whole
|
screen, remaining on the screen as your friendly assistant the whole
|
||||||
time you work on your computer.
|
time you work on your computer.
|
||||||
</P>
|
</P>
|
||||||
|
@ -260,7 +260,7 @@ of LS Studio you are working in, the Master Panel displays:</P>
|
||||||
<FONT SIZE=2 STYLE="font-size: 11pt"><I>Note: The content of the
|
<FONT SIZE=2 STYLE="font-size: 11pt"><I>Note: The content of the
|
||||||
Next Playing and VU meter fields is currently neither available nor
|
Next Playing and VU meter fields is currently neither available nor
|
||||||
visible. This is only a short description what these fields will
|
visible. This is only a short description what these fields will
|
||||||
indicate in an upcoming version of LiveSupport.</I></FONT></P>
|
indicate in an upcoming version of Campcaster.</I></FONT></P>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
||||||
<FONT COLOR="#000000"><B>logo</B> of your radio station - this can
|
<FONT COLOR="#000000"><B>logo</B> of your radio station - this can
|
||||||
|
@ -328,7 +328,7 @@ which displays the following :</P>
|
||||||
<LI><P CLASS="western" STYLE="margin-bottom: 0in">The <STRONG>Language
|
<LI><P CLASS="western" STYLE="margin-bottom: 0in">The <STRONG>Language
|
||||||
<SPAN STYLE="font-weight: medium">drop-down menu</SPAN></STRONG> –
|
<SPAN STYLE="font-weight: medium">drop-down menu</SPAN></STRONG> –
|
||||||
where you can select one of the available user interface
|
where you can select one of the available user interface
|
||||||
localizations of LiveSupport Studio from the list. The default
|
localizations of Campcaster Studio from the list. The default
|
||||||
language is English, but you can use one of the other localized
|
language is English, but you can use one of the other localized
|
||||||
versions we supply.</P>
|
versions we supply.</P>
|
||||||
</UL>
|
</UL>
|
||||||
|
@ -344,7 +344,7 @@ again if you quit LS Studio completely and start the program again.</P>
|
||||||
login or cancel the operation.</P>
|
login or cancel the operation.</P>
|
||||||
</UL>
|
</UL>
|
||||||
<P STYLE="margin-top: 0.19in; margin-bottom: 0.19in">After
|
<P STYLE="margin-top: 0.19in; margin-bottom: 0.19in">After
|
||||||
successfully presenting on the system and logging in into LiveSupport
|
successfully presenting on the system and logging in into Campcaster
|
||||||
Studio, you will be able to see the following:</P>
|
Studio, you will be able to see the following:</P>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
||||||
|
@ -353,7 +353,7 @@ Studio, you will be able to see the following:</P>
|
||||||
by the scheduler and play/stop functions of the audio slot.</P>
|
by the scheduler and play/stop functions of the audio slot.</P>
|
||||||
<LI><P CLASS="western" STYLE="margin-bottom: 0.19in">The <STRONG>Navigation
|
<LI><P CLASS="western" STYLE="margin-bottom: 0.19in">The <STRONG>Navigation
|
||||||
Menu</STRONG> – buttons for all the main functions you need
|
Menu</STRONG> – buttons for all the main functions you need
|
||||||
for operating LiveSupport Studio, depending on your user rights and
|
for operating Campcaster Studio, depending on your user rights and
|
||||||
permissions (previously determined by administrator)</P>
|
permissions (previously determined by administrator)</P>
|
||||||
</UL>
|
</UL>
|
||||||
<P LANG="" CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">
|
<P LANG="" CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">
|
||||||
|
@ -403,7 +403,7 @@ Navigation Menu consists of the following functions:</P>
|
||||||
broadcast schedule</P>
|
broadcast schedule</P>
|
||||||
<LI><P CLASS="western" STYLE="margin-bottom: 0.19in"><B>Search
|
<LI><P CLASS="western" STYLE="margin-bottom: 0.19in"><B>Search
|
||||||
</B>button – search and browse audio clips available in the
|
</B>button – search and browse audio clips available in the
|
||||||
LiveSupport storage server using the search criteria you set</P>
|
Campcaster storage server using the search criteria you set</P>
|
||||||
</UL>
|
</UL>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
|
@ -601,7 +601,7 @@ Upload file</B></FONT></H2>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">The 'upload file'
|
<P CLASS="western" STYLE="margin-bottom: 0in">The 'upload file'
|
||||||
option allows you to upload files from your local computer,
|
option allows you to upload files from your local computer,
|
||||||
LiveSupport server or any other available source into the system. It
|
Campcaster server or any other available source into the system. It
|
||||||
then appears in the ScratchPad.</P>
|
then appears in the ScratchPad.</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">Browsing the audio
|
<P CLASS="western" STYLE="margin-bottom: 0in">Browsing the audio
|
||||||
archive or any other source or disc, user can find the audio file
|
archive or any other source or disc, user can find the audio file
|
||||||
|
@ -650,7 +650,7 @@ palette consists of the following elements:</P>
|
||||||
<BR>
|
<BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-left: 0.5in; margin-bottom: 0in"><I>Note:
|
<P CLASS="western" STYLE="margin-left: 0.5in; margin-bottom: 0in"><I>Note:
|
||||||
If an MP3 file is uploaded, LiveSupport will automatically use the
|
If an MP3 file is uploaded, Campcaster will automatically use the
|
||||||
information stored in its ID3 tags, if there is any.</I></P>
|
information stored in its ID3 tags, if there is any.</I></P>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
<LI><P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0in">
|
||||||
|
@ -706,7 +706,7 @@ it appears at the top of the ScratchPad list).<SPAN STYLE="background: #000000">
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in"><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">As in LiveSupport
|
<P CLASS="western" STYLE="margin-bottom: 0in">As in Campcaster
|
||||||
Station, the ScratchPad represents your workspace during your entire
|
Station, the ScratchPad represents your workspace during your entire
|
||||||
session. It can be used for loading all the materials (audio files,
|
session. It can be used for loading all the materials (audio files,
|
||||||
playlists…) you find necessary for creating your program. The
|
playlists…) you find necessary for creating your program. The
|
||||||
|
@ -723,7 +723,7 @@ palette. It consists of the following elements:</P>
|
||||||
them in Live Mode or a playlist.</P>
|
them in Live Mode or a playlist.</P>
|
||||||
<LI><P STYLE="margin-bottom: 0in">The<B> Type</B> column –
|
<LI><P STYLE="margin-bottom: 0in">The<B> Type</B> column –
|
||||||
contains icons indicating the type of item you are working with. An
|
contains icons indicating the type of item you are working with. An
|
||||||
icon's appearance is the same as in LiveSupport Station –
|
icon's appearance is the same as in Campcaster Station –
|
||||||
audioclips are marked with a green note, playlists with a red note,
|
audioclips are marked with a green note, playlists with a red note,
|
||||||
and webstreams with a blue transmission symbol.</P>
|
and webstreams with a blue transmission symbol.</P>
|
||||||
<LI><P STYLE="margin-bottom: 0in">The <B>Title</B> column –
|
<LI><P STYLE="margin-bottom: 0in">The <B>Title</B> column –
|
||||||
|
@ -925,7 +925,7 @@ palette allows you to automate (schedule) your playlist for broadcast
|
||||||
at a predefined date and time.</P>
|
at a predefined date and time.</P>
|
||||||
<P STYLE="margin-top: 0.19in; margin-bottom: 0.19in">Clicking on the
|
<P STYLE="margin-top: 0.19in; margin-bottom: 0.19in">Clicking on the
|
||||||
Scheduler button in the Navigation menu opens up a palette similar to
|
Scheduler button in the Navigation menu opens up a palette similar to
|
||||||
the Scheduler Navigator from LiveSupport Station. The palette appears
|
the Scheduler Navigator from Campcaster Station. The palette appears
|
||||||
as a monthly calendar and contains the following elements:</P>
|
as a monthly calendar and contains the following elements:</P>
|
||||||
<UL>
|
<UL>
|
||||||
<LI><P STYLE="margin-top: 0.19in; margin-bottom: 0in"><B>Monthly
|
<LI><P STYLE="margin-top: 0.19in; margin-bottom: 0in"><B>Monthly
|
||||||
|
@ -987,7 +987,7 @@ stays in the ScratchPad for the next use.</P>
|
||||||
Search</B></FONT></H2>
|
Search</B></FONT></H2>
|
||||||
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">The
|
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">The
|
||||||
search palette allows you to search (on either a simple or advanced
|
search palette allows you to search (on either a simple or advanced
|
||||||
level) and browse the archive of available files in LiveSupport's
|
level) and browse the archive of available files in Campcaster's
|
||||||
storage server, in order to use them for creating playlists,
|
storage server, in order to use them for creating playlists,
|
||||||
scheduling or creating Live Mode lists. You can start looking for
|
scheduling or creating Live Mode lists. You can start looking for
|
||||||
audioclips not only by title, but also by general searching metadata
|
audioclips not only by title, but also by general searching metadata
|
||||||
|
@ -1062,7 +1062,7 @@ Advanced Search</B></FONT></H3>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in">Advanced Search also
|
<P CLASS="western" STYLE="margin-bottom: 0in">Advanced Search also
|
||||||
works as a regular search engine. As in simple search mode, you can
|
works as a regular search engine. As in simple search mode, you can
|
||||||
search the metadata that you and other LiveSupport users have input
|
search the metadata that you and other Campcaster users have input
|
||||||
during the upload process. The main difference is that Advanced
|
during the upload process. The main difference is that Advanced
|
||||||
Search allows you to select as much metadata criteria as you find
|
Search allows you to select as much metadata criteria as you find
|
||||||
relevant to make your search successful. All the search results will
|
relevant to make your search successful. All the search results will
|
||||||
|
@ -1075,7 +1075,7 @@ Advanced Search tab contains the following elements:</P>
|
||||||
</P>
|
</P>
|
||||||
<LI><P CLASS="western" STYLE="margin-bottom: 0in">The left pulldown
|
<LI><P CLASS="western" STYLE="margin-bottom: 0in">The left pulldown
|
||||||
menu allows you to select one metadata criterium you find relevant
|
menu allows you to select one metadata criterium you find relevant
|
||||||
for the search. You can choose any metadata that LiveSupport offers
|
for the search. You can choose any metadata that Campcaster offers
|
||||||
and users have input to describe audio content (title, genre,
|
and users have input to describe audio content (title, genre,
|
||||||
length, album, mood, bitrate).
|
length, album, mood, bitrate).
|
||||||
</P>
|
</P>
|
||||||
|
@ -1118,7 +1118,7 @@ precise and narrow your search results.</P>
|
||||||
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in"><BR><BR>
|
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in"><BR><BR>
|
||||||
</P>
|
</P>
|
||||||
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">Like
|
<P CLASS="western" STYLE="margin-top: 0.19in; margin-bottom: 0.19in">Like
|
||||||
in LiveSupport Station, the Browse function in LiveSupport Studio
|
in Campcaster Station, the Browse function in Campcaster Studio
|
||||||
allows you to browse all files from the server according to general
|
allows you to browse all files from the server according to general
|
||||||
criteria you specify. In order to narrow search results as much as
|
criteria you specify. In order to narrow search results as much as
|
||||||
possible, the browse function gives you the opportunity to choose
|
possible, the browse function gives you the opportunity to choose
|
||||||
|
@ -1167,18 +1167,18 @@ the search result table, a menu appears offering operations:</P>
|
||||||
<H1 CLASS="western">2. Additional information</H1>
|
<H1 CLASS="western">2. Additional information</H1>
|
||||||
<H2 CLASS="western"><B>2.1 Where to go for more help</B></H2>
|
<H2 CLASS="western"><B>2.1 Where to go for more help</B></H2>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><FONT SIZE=2 STYLE="font-size: 11pt"><FONT SIZE=3>You
|
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><FONT SIZE=2 STYLE="font-size: 11pt"><FONT SIZE=3>You
|
||||||
can visit LiveSupport's discussion forums online at
|
can visit Campcaster's discussion forums online at
|
||||||
</FONT><A HREF="http://livesupport.campware.org/"><FONT SIZE=3>http://livesupport.campware.org</FONT></A><FONT SIZE=3>.
|
</FONT><A HREF="http://campcaster.campware.org/"><FONT SIZE=3>http://campcaster.campware.org</FONT></A><FONT SIZE=3>.
|
||||||
There you will also find program updates and other useful
|
There you will also find program updates and other useful
|
||||||
information.</FONT></FONT></P>
|
information.</FONT></FONT></P>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><BR>
|
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><BR>
|
||||||
</P>
|
</P>
|
||||||
<H2 CLASS="western">2.2 How to report bugs</H2>
|
<H2 CLASS="western">2.2 How to report bugs</H2>
|
||||||
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><FONT SIZE=3>LiveSupport
|
<P CLASS="western" STYLE="margin-bottom: 0in; font-weight: medium"><FONT SIZE=3>Campcaster
|
||||||
needs your input to constantly improve. If the software doesn't
|
needs your input to constantly improve. If the software doesn't
|
||||||
behave as it should, please let us know about it by entering a
|
behave as it should, please let us know about it by entering a
|
||||||
trouble ticket at <A HREF="http://code.campware.org/projects/livesupport">http://code.campware.org/projects/livesupport</A>.
|
trouble ticket at <A HREF="http://code.campware.org/projects/campcaster">http://code.campware.org/projects/campcaster</A>.
|
||||||
That way, the LiveSupport team can keep track of your problem and you
|
That way, the Campcaster team can keep track of your problem and you
|
||||||
can check to see whether it has been fixed.</FONT></P>
|
can check to see whether it has been fixed.</FONT></P>
|
||||||
</BODY>
|
</BODY>
|
||||||
</HTML>
|
</HTML>
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Authentication specification</title>
|
<title>Campcaster Authentication specification</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document contains the specification of the LiveSupport
|
This document contains the specification of the Campcaster
|
||||||
Authentication component.<br>
|
Authentication component.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
|
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Local storage specification</title>
|
<title>Campcaster Local storage specification</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document contains the specification of the LiveSupport Local
|
This document contains the specification of the Campcaster Local
|
||||||
storage component.<br>
|
storage component.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
|
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Media archive specification</title>
|
<title>Campcaster Media archive specification</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document contains the specification of the LiveSupport Media
|
This document contains the specification of the Campcaster Media
|
||||||
archive component.<br>
|
archive component.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
|
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Playlist editor specification</title>
|
<title>Campcaster Playlist editor specification</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document contains the specification of the LiveSupport Playlist
|
This document contains the specification of the Campcaster Playlist
|
||||||
editor component.<br>
|
editor component.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
|
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Scheduler specifications</title>
|
<title>Campcaster Scheduler specifications</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document contains the specification of the LiveSupport Scheduler
|
This document contains the specification of the Campcaster Scheduler
|
||||||
daemon.<br>
|
daemon.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
|
@ -28,7 +28,7 @@ capable browser is needed to view it, or an SVG plugin like <a
|
||||||
<h1>Requirements</h1>
|
<h1>Requirements</h1>
|
||||||
<h2>Overview<br>
|
<h2>Overview<br>
|
||||||
</h2>
|
</h2>
|
||||||
The purpose of the LiveSupport Scheduler daemon is to execute
|
The purpose of the Campcaster Scheduler daemon is to execute
|
||||||
playlists.<br>
|
playlists.<br>
|
||||||
<h2>Goals<br>
|
<h2>Goals<br>
|
||||||
</h2>
|
</h2>
|
||||||
|
|
|
@ -3,12 +3,11 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Software Architecture</title>
|
<title>Campcaster Software Architecture</title>
|
||||||
<meta content="Akos Maroy" name="author">
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +17,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the software architecture of LiveSupport.<br>
|
This document describes the software architecture of Campcaster.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
href="http://www.w3.org/Graphics/SVG/">SVG</a> figures, thus an SVG
|
href="http://www.w3.org/Graphics/SVG/">SVG</a> figures, thus an SVG
|
||||||
|
@ -42,13 +41,13 @@ The software architecture for the Playlist Editor:<br>
|
||||||
A brief summary of the software components appearing in the figures
|
A brief summary of the software components appearing in the figures
|
||||||
above:<br>
|
above:<br>
|
||||||
<h2>Scheduler</h2>
|
<h2>Scheduler</h2>
|
||||||
The LiveSupport Scheduler, responsible for executing playlists.<br>
|
The Campcaster Scheduler, responsible for executing playlists.<br>
|
||||||
<h2>Playlist editor</h2>
|
<h2>Playlist editor</h2>
|
||||||
The LiveSupport Playlist editor, a graphical user interface component.<br>
|
The Campcaster Playlist editor, a graphical user interface component.<br>
|
||||||
<h2>Media Archive</h2>
|
<h2>Media Archive</h2>
|
||||||
The LiveSupport Media Archive component.<br>
|
The Campcaster Media Archive component.<br>
|
||||||
<h2>Local storage</h2>
|
<h2>Local storage</h2>
|
||||||
The LiveSupport Local Storage component.<br>
|
The Campcaster Local Storage component.<br>
|
||||||
<h2>Helix Client Library</h2>
|
<h2>Helix Client Library</h2>
|
||||||
A media library developed by the <a href="https://helixcommunity.org/">Helix
|
A media library developed by the <a href="https://helixcommunity.org/">Helix
|
||||||
Community</a> and <a href="http://www.realnetworks.com/">Real Networks</a>.
|
Community</a> and <a href="http://www.realnetworks.com/">Real Networks</a>.
|
||||||
|
|
|
@ -3,12 +3,12 @@
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=ISO-8859-2"
|
<meta content="text/html; charset=ISO-8859-2"
|
||||||
http-equiv="content-type">
|
http-equiv="content-type">
|
||||||
<title>LiveSupport Architecture</title>
|
<title>Campcaster Architecture</title>
|
||||||
<meta content="Ákos Maróy" name="author">
|
<meta content="<EFBFBD>kos Mar<61>y" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,7 +18,7 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
<li>Location: $URL$</li>
|
<li>Location: $URL$</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the architecture of LiveSupport.<br>
|
This document describes the architecture of Campcaster.<br>
|
||||||
<br>
|
<br>
|
||||||
This document contains embedded <a
|
This document contains embedded <a
|
||||||
href="http://www.w3.org/Graphics/SVG/">SVG</a> figures, thus an SVG
|
href="http://www.w3.org/Graphics/SVG/">SVG</a> figures, thus an SVG
|
||||||
|
@ -54,13 +54,13 @@ The <a href="PlaylistEditor/index.html">Playlist editor</a> component
|
||||||
is the user interface tool to create playlists.<br>
|
is the user interface tool to create playlists.<br>
|
||||||
<h1>Feature - component mapping</h1>
|
<h1>Feature - component mapping</h1>
|
||||||
This section contains a mapping from the features listed in section 3.3
|
This section contains a mapping from the features listed in section 3.3
|
||||||
the original LiveSupport proposal to the components that fulfill these
|
the original Campcaster proposal to the components that fulfill these
|
||||||
features.<br>
|
features.<br>
|
||||||
<h2>LiveSupport Feature List</h2>
|
<h2>Campcaster Feature List</h2>
|
||||||
For convenience the features listed in section 3.3 of the LiveSupport
|
For convenience the features listed in section 3.3 of the Campcaster
|
||||||
proposal are quoted below, with their original section numbers.<br>
|
proposal are quoted below, with their original section numbers.<br>
|
||||||
<h3>3.3.1 Intuitive User Interface</h3>
|
<h3>3.3.1 Intuitive User Interface</h3>
|
||||||
<p>LiveSupport will feature an
|
<p>Campcaster will feature an
|
||||||
easily-localizable and intuitive user interface that draws on the
|
easily-localizable and intuitive user interface that draws on the
|
||||||
applicants’ extensive previous project experience.</p>
|
applicants’ extensive previous project experience.</p>
|
||||||
<h3>3.3.2 Storing Metadata</h3>
|
<h3>3.3.2 Storing Metadata</h3>
|
||||||
|
@ -71,14 +71,14 @@ on artist, title, record, genre, track number and so on. It is
|
||||||
impossible to store essential information like the language of an
|
impossible to store essential information like the language of an
|
||||||
audio file – essential for spoken word productions, such as
|
audio file – essential for spoken word productions, such as
|
||||||
educational or news material.</p>
|
educational or news material.</p>
|
||||||
<p>LiveSupport will use existing open
|
<p>Campcaster will use existing open
|
||||||
standards, such as RSS feed standards in XML format, to store all
|
standards, such as RSS feed standards in XML format, to store all
|
||||||
information needed to describe a file sufficiently. Additionally,
|
information needed to describe a file sufficiently. Additionally,
|
||||||
this metadata information will fully support the Unicode format,
|
this metadata information will fully support the Unicode format,
|
||||||
making the database of metadata available to all character sets and
|
making the database of metadata available to all character sets and
|
||||||
fully searchable.</p>
|
fully searchable.</p>
|
||||||
<h3>3.3.3 Automation and Scheduling</h3>
|
<h3>3.3.3 Automation and Scheduling</h3>
|
||||||
<p>LiveSupport will provide a scheduler,
|
<p>Campcaster will provide a scheduler,
|
||||||
allowing stations to fill parts of the radio schedule with automated
|
allowing stations to fill parts of the radio schedule with automated
|
||||||
broadcasts. Throughout automated broadcasting times, the station will
|
broadcasts. Throughout automated broadcasting times, the station will
|
||||||
still be able to deliver advertisement, generating income while
|
still be able to deliver advertisement, generating income while
|
||||||
|
@ -90,31 +90,31 @@ community.</p>
|
||||||
world mainly use playlists generated by audio player software such as
|
world mainly use playlists generated by audio player software such as
|
||||||
MusicMatch, Windows MediaPlayer or WinAMP. Such simple playlists
|
MusicMatch, Windows MediaPlayer or WinAMP. Such simple playlists
|
||||||
provide no more information than a list of file names, and are
|
provide no more information than a list of file names, and are
|
||||||
inaccessible for full text search. As mentioned above, LiveSupport
|
inaccessible for full text search. As mentioned above, Campcaster
|
||||||
will use the potential of XML metadata in Unicode to manage and
|
will use the potential of XML metadata in Unicode to manage and
|
||||||
archive playlists.</p>
|
archive playlists.</p>
|
||||||
<h3>3.3.5 Proof of Broadcast</h3>
|
<h3>3.3.5 Proof of Broadcast</h3>
|
||||||
<p>Proof of broadcast is essential to
|
<p>Proof of broadcast is essential to
|
||||||
establish serious business relationships with advertisers.
|
establish serious business relationships with advertisers.
|
||||||
LiveSupport will provide accurate and detailed log files stating the
|
Campcaster will provide accurate and detailed log files stating the
|
||||||
precise time each item was broadcast over the system. In a
|
precise time each item was broadcast over the system. In a
|
||||||
radio-network context, the proof of broadcast tool developed by MDLF
|
radio-network context, the proof of broadcast tool developed by MDLF
|
||||||
in conjunction with Radio 68H in Indonesia will be used to aggregate
|
in conjunction with Radio 68H in Indonesia will be used to aggregate
|
||||||
and analyze logs created by individual LiveSupport installations.</p>
|
and analyze logs created by individual Campcaster installations.</p>
|
||||||
<h3>3.3.6 Mixing Local Audio Sources</h3>
|
<h3>3.3.6 Mixing Local Audio Sources</h3>
|
||||||
<p>A producer running LiveSupport in a
|
<p>A producer running Campcaster in a
|
||||||
studio will be able to mix audio files (e.g. reports, music,
|
studio will be able to mix audio files (e.g. reports, music,
|
||||||
jingles), phone calls and the microphone into a live broadcast.</p>
|
jingles), phone calls and the microphone into a live broadcast.</p>
|
||||||
<h3>3.3.7 Mixing Local and Remote Sources</h3>
|
<h3>3.3.7 Mixing Local and Remote Sources</h3>
|
||||||
<p>If connected to the Internet, and given
|
<p>If connected to the Internet, and given
|
||||||
enough available bandwidth, LiveSupport will be able to play local
|
enough available bandwidth, Campcaster will be able to play local
|
||||||
files (stored on the system’s hard disk), remote files (stored
|
files (stored on the system’s hard disk), remote files (stored
|
||||||
anywhere on the Internet) or include audio streams from the Internet
|
anywhere on the Internet) or include audio streams from the Internet
|
||||||
as part of the local transmission – all of which could also become
|
as part of the local transmission – all of which could also become
|
||||||
part of a playlist.</p>
|
part of a playlist.</p>
|
||||||
<h3>3.3.8 Remote Control of Transmitter Locations</h3>
|
<h3>3.3.8 Remote Control of Transmitter Locations</h3>
|
||||||
<p>A radio reporter/producer will be able
|
<p>A radio reporter/producer will be able
|
||||||
to remotely access all of LiveSupport’s scheduling features over
|
to remotely access all of Campcaster’s scheduling features over
|
||||||
the Internet using a standard web browser. She will be able to upload
|
the Internet using a standard web browser. She will be able to upload
|
||||||
audio programs as well as create playlists and schedule transmission.</p>
|
audio programs as well as create playlists and schedule transmission.</p>
|
||||||
<h2>Feature - component mapping</h2>
|
<h2>Feature - component mapping</h2>
|
||||||
|
|
|
@ -18,7 +18,7 @@
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td valign="top"><img src="livesupport_logo_blends.png" width="114" height="83" align="top"></td>
|
<td valign="top"><img src="livesupport_logo_blends.png" width="114" height="83" align="top"></td>
|
||||||
<td valign="top"><p><font size="+3" face="Bitstream Vera Sans, Verdana, Arial, sans-serif"><strong><font color="#F95916" size="6">LiveSupport 1.0</font><br>
|
<td valign="top"><p><font size="+3" face="Bitstream Vera Sans, Verdana, Arial, sans-serif"><strong><font color="#F95916" size="6">Campcaster 1.0</font><br>
|
||||||
</strong><font size="+2">Demo and Install CD
|
</strong><font size="+2">Demo and Install CD
|
||||||
</font></font></p>
|
</font></font></p>
|
||||||
</td>
|
</td>
|
||||||
|
@ -27,32 +27,32 @@
|
||||||
<td width="24%" valign="top"> </td>
|
<td width="24%" valign="top"> </td>
|
||||||
<td width="76%"><p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">This
|
<td width="76%"><p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">This
|
||||||
CD is a bootable version of Linux for PCs that includes a demo version
|
CD is a bootable version of Linux for PCs that includes a demo version
|
||||||
of LiveSupport preinstalled.</font></p>
|
of Campcaster preinstalled.</font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">To start,
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">To start,
|
||||||
insert this CD into your CD-ROM drive and restart your computer.<br>
|
insert this CD into your CD-ROM drive and restart your computer.<br>
|
||||||
You will be prompted for a boot option. Type ‘knoppix’ and the
|
You will be prompted for a boot option. Type ‘knoppix’ and the
|
||||||
enter key and the startup procedure will continue.</font></p> <p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">The <a href="http://www.kde.org">K
|
enter key and the startup procedure will continue.</font></p> <p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">The <a href="http://www.kde.org">K
|
||||||
Desktop environment</a> (KDE), which is very similar to Windows, will appear. To
|
Desktop environment</a> (KDE), which is very similar to Windows, will appear. To
|
||||||
start the LiveSupport Studio application, click on its desktop icon.</font></p>
|
start the Campcaster Studio application, click on its desktop icon.</font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> For both
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> For both
|
||||||
LiveSupport Studio and web access, The username is ‘root,’ and
|
Campcaster Studio and web access, The username is ‘root,’ and
|
||||||
the password is ‘q’ for the demo.</font></p>
|
the password is ‘q’ for the demo.</font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">You may
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">You may
|
||||||
also access LiveSupport Station on this demo through a web browser.
|
also access Campcaster Station on this demo through a web browser.
|
||||||
Click the globe icon in the task bar to start the Mozilla Firefox browser.</font></p>
|
Click the globe icon in the task bar to start the Mozilla Firefox browser.</font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> In the
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> In the
|
||||||
URL field, type: <a href="http://localhost/livesupport">http://localhost/livesupport</a>.</font></p>
|
URL field, type: <a href="http://localhost/campcaster">http://localhost/campcaster</a>.</font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> You
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif"> You
|
||||||
may also choose to install the operating system and LiveSupport to
|
may also choose to install the operating system and Campcaster to
|
||||||
your
|
your
|
||||||
hard disk. Note: Installation to the hard disk is intended for experienced
|
hard disk. Note: Installation to the hard disk is intended for experienced
|
||||||
users, and is intended for new computers. </font></p>
|
users, and is intended for new computers. </font></p>
|
||||||
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">As with
|
<p><font face="Bitstream Vera Sans, Verdana, Arial, sans-serif">As with
|
||||||
most open source software, LiveSupport is undergoing frequent updates.
|
most open source software, Campcaster is undergoing frequent updates.
|
||||||
For more information, including news about program updates, check our
|
For more information, including news about program updates, check our
|
||||||
website
|
website
|
||||||
frequently
|
frequently
|
||||||
at <a href="http://livesupport.campware.org">http://livesupport.campware.org</a></font></p></td>
|
at <a href="http://campcaster.campware.org">http://campcaster.campware.org</a></font></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport release process documentation</title>
|
<title>Campcaster release process documentation</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,17 +18,17 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the process of releasing a new version of
|
This document describes the process of releasing a new version of
|
||||||
LiveSupport. Obviously this document is only relevant to people who
|
Campcaster. Obviously this document is only relevant to people who
|
||||||
have the rights and permissions to make such a release.<br>
|
have the rights and permissions to make such a release.<br>
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
For all the releases of LiveSupport to remain consistent, it is
|
For all the releases of Campcaster to remain consistent, it is
|
||||||
preferable to have a repeatable release process, which will be followed
|
preferable to have a repeatable release process, which will be followed
|
||||||
when creating releases. This ensures that no matter who creates the
|
when creating releases. This ensures that no matter who creates the
|
||||||
releases, they will remain similar.<br>
|
releases, they will remain similar.<br>
|
||||||
<br>
|
<br>
|
||||||
The release process boils down to the following steps:<br>
|
The release process boils down to the following steps:<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li>getting LiveSupport sources</li>
|
<li>getting Campcaster sources</li>
|
||||||
<li>checking the distribution script</li>
|
<li>checking the distribution script</li>
|
||||||
<li>updating release version and changelog<br>
|
<li>updating release version and changelog<br>
|
||||||
</li>
|
</li>
|
||||||
|
@ -41,9 +41,9 @@ The release process boils down to the following steps:<br>
|
||||||
<li>announcing the release<br>
|
<li>announcing the release<br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Getting LiveSupport sources</h1>
|
<h1>Getting Campcaster sources</h1>
|
||||||
It is assumed that the person doing the release has a read/write access
|
It is assumed that the person doing the release has a read/write access
|
||||||
to the LiveSupport version control system. As a first step of the
|
to the Campcaster version control system. As a first step of the
|
||||||
release process, a fresh copy of the version control repository is
|
release process, a fresh copy of the version control repository is
|
||||||
exported, so as to insure that:<br>
|
exported, so as to insure that:<br>
|
||||||
<ul>
|
<ul>
|
||||||
|
@ -51,10 +51,10 @@ exported, so as to insure that:<br>
|
||||||
control system</li>
|
control system</li>
|
||||||
<li>there are no generated files in the release</li>
|
<li>there are no generated files in the release</li>
|
||||||
</ul>
|
</ul>
|
||||||
To get a fresh copy of the LiveSupport repository, execute the
|
To get a fresh copy of the Campcaster repository, execute the
|
||||||
following in an empty directory:<br>
|
following in an empty directory:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>svn export svn+ssh://<username>@code.campware.org/home/svn/repo/livesupport/trunk/livesupport</code><br></pre>
|
<pre><code>svn export svn+ssh://<username>@code.campware.org/home/svn/repo/campcaster/trunk/campcaster</code><br></pre>
|
||||||
<br>
|
<br>
|
||||||
Where <code><username></code> is the user name for accessing the
|
Where <code><username></code> is the user name for accessing the
|
||||||
repository of the person making the release.<br>
|
repository of the person making the release.<br>
|
||||||
|
@ -79,10 +79,10 @@ is a mismatch between the release version and the topmost entry in the
|
||||||
debian changelog file.<br>
|
debian changelog file.<br>
|
||||||
<br>
|
<br>
|
||||||
Curently, only the debian changelog keeps track of the changes and the
|
Curently, only the debian changelog keeps track of the changes and the
|
||||||
version of LiveSupport. To update the changelog, edit <code>etc/debian/changelog</code>,
|
version of Campcaster. To update the changelog, edit <code>etc/debian/changelog</code>,
|
||||||
by inserting a section onto the top of the file:<br>
|
by inserting a section onto the top of the file:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre>livesupport (<ls-version>-1) unstable; urgency=low<br><br> * Changes listed here<br><br> -- <code>Package Maintainer <maintainer@foo.bar></code> <timestamp><br><br></pre>
|
<pre>campcaster (<ls-version>-1) unstable; urgency=low<br><br> * Changes listed here<br><br> -- <code>Package Maintainer <maintainer@foo.bar></code> <timestamp><br><br></pre>
|
||||||
The timestamp above must be preceeded by two spaces, and must be an RFC
|
The timestamp above must be preceeded by two spaces, and must be an RFC
|
||||||
2822 compliant date string, which is most easily produced by issuing
|
2822 compliant date string, which is most easily produced by issuing
|
||||||
the <code>date -R</code> command. Please note that the debian package
|
the <code>date -R</code> command. Please note that the debian package
|
||||||
|
@ -101,13 +101,13 @@ with the release version as its single parameter:<br>
|
||||||
<br>
|
<br>
|
||||||
This will create two tarballs in the current directory:<br>
|
This will create two tarballs in the current directory:<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>livesupport-<ls-version>.tar.bz2</code></li>
|
<li><code>campcaster-<ls-version>.tar.bz2</code></li>
|
||||||
<li><code>livesupport-libraries-<ls-version>.tar.bz2</code></li>
|
<li><code>campcaster-libraries-<ls-version>.tar.bz2</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1>Testing the tarballs</h1>
|
<h1>Testing the tarballs</h1>
|
||||||
Having broken releases is very annoying, thus it is highly recommended
|
Having broken releases is very annoying, thus it is highly recommended
|
||||||
that the release tarballs are tested on a plain vanilla system. To test
|
that the release tarballs are tested on a plain vanilla system. To test
|
||||||
the tarballs, follow the procedure described in the LiveSupport <a
|
the tarballs, follow the procedure described in the Campcaster <a
|
||||||
href="install.html">installation document</a>.<br>
|
href="install.html">installation document</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
Do not publish tarballs that have not been tested, or are known to be
|
Do not publish tarballs that have not been tested, or are known to be
|
||||||
|
@ -117,13 +117,13 @@ After the source tarballs have been tested, Debian source and binary
|
||||||
packages can be created. To do so, upload the source tarballs to a
|
packages can be created. To do so, upload the source tarballs to a
|
||||||
Debian system, and do the following:<br>
|
Debian system, and do the following:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>tar xfj livesupport-<ls-version>.tar.bz2<br>tar xfj livesupport-libraries-<ls-version>.tar.bz2<br>cd livesupport-<ls-version><br>./bin/createDebianPackages.sh -d .. -v <ls-version> -m "Package Maintainer <maintainer@foo.bar>" -o ..<br>cd ..<br></code></pre>
|
<pre><code>tar xfj campcaster-<ls-version>.tar.bz2<br>tar xfj campcaster-libraries-<ls-version>.tar.bz2<br>cd campcaster-<ls-version><br>./bin/createDebianPackages.sh -d .. -v <ls-version> -m "Package Maintainer <maintainer@foo.bar>" -o ..<br>cd ..<br></code></pre>
|
||||||
<br>
|
<br>
|
||||||
The above command will create the Debain source package files next to
|
The above command will create the Debain source package files next to
|
||||||
the original source tarballs. The script will generate the following
|
the original source tarballs. The script will generate the following
|
||||||
files, making up the Debian source package:<br>
|
files, making up the Debian source package:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>livesupport_<ls-version>-1.dsc<br></code><code>livesupport_<ls-version>-1.diff.gz<br></code><code>livesupport_<ls-version>.orig.tar.gz<br><br></code></pre>
|
<pre><code>campcaster_<ls-version>-1.dsc<br></code><code>campcaster_<ls-version>-1.diff.gz<br></code><code>campcaster_<ls-version>.orig.tar.gz<br><br></code></pre>
|
||||||
Based on the source packages, the Debian package management system can
|
Based on the source packages, the Debian package management system can
|
||||||
build the binaries for the current target platform, provided all the
|
build the binaries for the current target platform, provided all the
|
||||||
necessary packages required to build are installed on the system. For a
|
necessary packages required to build are installed on the system. For a
|
||||||
|
@ -132,35 +132,35 @@ in extracted debianized source tree generated below.<br>
|
||||||
Building is best done
|
Building is best done
|
||||||
in an empty directory as follows:<br>
|
in an empty directory as follows:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>rm -rf /opt/livesupport<br>rm -rf debian_build<br>mkdir debian_build<br>cd debian_build<br></code>dpkg-source -x ../livesupport_<ls_version>-1.dsc<br>cd livesupport-<ls-version><br>dpkg-buildpackage -rfakeroot<br>cd ../..<br><br></pre>
|
<pre><code>rm -rf /opt/campcaster<br>rm -rf debian_build<br>mkdir debian_build<br>cd debian_build<br></code>dpkg-source -x ../campcaster_<ls_version>-1.dsc<br>cd campcaster-<ls-version><br>dpkg-buildpackage -rfakeroot<br>cd ../..<br><br></pre>
|
||||||
The above commands will result in the following debian packages:<br>
|
The above commands will result in the following debian packages:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>livesupport-libs_<ls-version>-1_<arch>.deb<br></code><code>livesupport-station_<ls-version>-1_<arch>.deb<br></code><code>livesupport-studio_<ls-version>-1_<arch>.deb</code><br></pre>
|
<pre><code>campcaster-libs_<ls-version>-1_<arch>.deb<br></code><code>campcaster-station_<ls-version>-1_<arch>.deb<br></code><code>campcaster-studio_<ls-version>-1_<arch>.deb</code><br></pre>
|
||||||
<pre><code></code><code></code></pre>
|
<pre><code></code><code></code></pre>
|
||||||
|
|
||||||
<h1>Tagging the sources</h1>
|
<h1>Tagging the sources</h1>
|
||||||
After the tarballs have been tested, the release can be finalized. As a
|
After the tarballs have been tested, the release can be finalized. As a
|
||||||
first step, the current state of the LiveSupport version control
|
first step, the current state of the Campcaster version control
|
||||||
repository has to be tagged, so that the the very versions in the
|
repository has to be tagged, so that the the very versions in the
|
||||||
release can be retrieved at any later date. To tag the repository,
|
release can be retrieved at any later date. To tag the repository,
|
||||||
issue the following command:<br>
|
issue the following command:<br>
|
||||||
<br>
|
<br>
|
||||||
<pre><code>svn copy svn+ssh://<username>@code.campware.org/home/svn/repo/livesupport/trunk/ \
|
<pre><code>svn copy svn+ssh://<username>@code.campware.org/home/svn/repo/campcaster/trunk/ \
|
||||||
svn+ssh://<username>@code.campware.org/home/svn/repo/livesupport/tags/livesupport-<ls-version><br></code></pre>
|
svn+ssh://<username>@code.campware.org/home/svn/repo/campcaster/tags/campcaster-<ls-version><br></code></pre>
|
||||||
<br>
|
<br>
|
||||||
This will tag the current state of the repository with the tag <code>livesupport-<ls-version></code>,
|
This will tag the current state of the repository with the tag <code>campcaster-<ls-version></code>,
|
||||||
enabling later retrieval of this specific state.<br>
|
enabling later retrieval of this specific state.<br>
|
||||||
|
|
||||||
<h1>Updating Trac</h1>
|
<h1>Updating Trac</h1>
|
||||||
Add the new version number to the Version pull-down menu in Trac by
|
Add the new version number to the Version pull-down menu in Trac by
|
||||||
executing
|
executing
|
||||||
<pre><code>trac-admin /usr/local/trac-projects/livesupport version add <ls-version></code></pre>
|
<pre><code>trac-admin /usr/local/trac-projects/campcaster version add <ls-version></code></pre>
|
||||||
on <code>code.campware.org</code>.
|
on <code>code.campware.org</code>.
|
||||||
|
|
||||||
<h1>Publishing the tarballs</h1>
|
<h1>Publishing the tarballs</h1>
|
||||||
To make the release available to the public, the created tarballs have
|
To make the release available to the public, the created tarballs have
|
||||||
to be published. This is done by making the files accessible under the
|
to be published. This is done by making the files accessible under the
|
||||||
LiveSupport project page on SourceForge: <code>http://sourceforge.net/projects/livesupport</code><span
|
Campcaster project page on SourceForge: <code>http://sourceforge.net/projects/campcaster</code><span
|
||||||
style="font-family: monospace;"></span><code></code>. Currently, only
|
style="font-family: monospace;"></span><code></code>. Currently, only
|
||||||
MDLF support staff have access to publish into this
|
MDLF support staff have access to publish into this
|
||||||
space, so after creating the tarballs, one should contact them
|
space, so after creating the tarballs, one should contact them
|
||||||
|
@ -180,7 +180,7 @@ are made:<br>
|
||||||
<li> PRweb (<a class="moz-txt-link-freetext"
|
<li> PRweb (<a class="moz-txt-link-freetext"
|
||||||
href="http://www.prweb.com/">http://www.prweb.com</a>)</li>
|
href="http://www.prweb.com/">http://www.prweb.com</a>)</li>
|
||||||
<li>MDLF's press person</li>
|
<li>MDLF's press person</li>
|
||||||
<li> LiveSupport developers' list, urging everyone to send it to
|
<li> Campcaster developers' list, urging everyone to send it to
|
||||||
friends and contacts</li>
|
friends and contacts</li>
|
||||||
<li>Other Campware developers' lists on major releases</li>
|
<li>Other Campware developers' lists on major releases</li>
|
||||||
<li> Other mailing lists and friendly/relevant organizations</li>
|
<li> Other mailing lists and friendly/relevant organizations</li>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport documentation for LS Studio localization</title>
|
<title>Campcaster documentation for LS Studio localization</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -19,10 +19,10 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
|
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document describes the process of adding a new language to the
|
This document describes the process of adding a new language to the
|
||||||
LiveSupport Studio localization. It is written for developers.<br>
|
Campcaster Studio localization. It is written for developers.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
LiveSupport Studio (a.k.a. the C++ GUI) uses IBM's
|
Campcaster Studio (a.k.a. the C++ GUI) uses IBM's
|
||||||
<a href="http://www-306.ibm.com/software/globalization/icu/index.jsp">ICU</a>
|
<a href="http://www-306.ibm.com/software/globalization/icu/index.jsp">ICU</a>
|
||||||
library for localization. This library supports a fallback mechanism:
|
library for localization. This library supports a fallback mechanism:
|
||||||
if the locale is set to <b>es_GT</b> (Guatemalan Spanish), it first tries to
|
if the locale is set to <b>es_GT</b> (Guatemalan Spanish), it first tries to
|
||||||
|
@ -73,9 +73,9 @@ binary <i>resource bundle</i> files using ICU's <code>genrb</code> program
|
||||||
The file name should be the locale name, followed by ".txt".
|
The file name should be the locale name, followed by ".txt".
|
||||||
<li>Add a new line for the new language in each of the files
|
<li>Add a new line for the new language in each of the files
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>gLiveSupport.xml</code></li>
|
<li><code>campcaster-studio.xml</code></li>
|
||||||
<li><code>gLiveSupport.xml.template</code></li>
|
<li><code>campcaster-studio.xml.template</code></li>
|
||||||
<li><code>gLiveSupport.xml.user-template</code></li>
|
<li><code>campcaster-studio.xml.user-template</code></li>
|
||||||
<li><code>Makefile.in</code></li>
|
<li><code>Makefile.in</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
in the <code>products/gLiveSupport/etc</code> directory.</li>
|
in the <code>products/gLiveSupport/etc</code> directory.</li>
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
<title>LiveSupport user localization instructions</title>
|
<title>Campcaster user localization instructions</title>
|
||||||
<meta content="$Author$" name="author">
|
<meta content="$Author$" name="author">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Preface</h1>
|
<h1>Preface</h1>
|
||||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||||
Development Loan Fund</a>, under the GNU <a
|
Development Loan Fund</a>, under the GNU <a
|
||||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||||
|
@ -18,15 +18,15 @@ Development Loan Fund</a>, under the GNU <a
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h1>Scope</h1>
|
<h1>Scope</h1>
|
||||||
This document is written to help non-developers translate the LiveSupport
|
This document is written to help non-developers translate the Campcaster
|
||||||
software into new languages.<br>
|
software into new languages.<br>
|
||||||
|
|
||||||
<h1>Introduction</h1>
|
<h1>Introduction</h1>
|
||||||
LiveSupport has two user interfaces: a web interface, intended mainly for
|
Campcaster has two user interfaces: a web interface, intended mainly for
|
||||||
radio station administrators (Station), and a stand-alone graphical user
|
radio station administrators (Station), and a stand-alone graphical user
|
||||||
interface, for disk jockeys and such (Studio).<br>
|
interface, for disk jockeys and such (Studio).<br>
|
||||||
|
|
||||||
<h1>Localization of LiveSupport Station</h1>
|
<h1>Localization of Campcaster Station</h1>
|
||||||
Please do the localization at
|
Please do the localization at
|
||||||
<p><a href="http://ls-dev.campware.org/~sebastian/htmlUI/var/localizer/"><code>http://ls-dev.campware.org/~sebastian/htmlUI/var/localizer/</code></a></p>
|
<p><a href="http://ls-dev.campware.org/~sebastian/htmlUI/var/localizer/"><code>http://ls-dev.campware.org/~sebastian/htmlUI/var/localizer/</code></a></p>
|
||||||
<p>(user name is "root", and the password is "q"). When done, send a notice to
|
<p>(user name is "root", and the password is "q"). When done, send a notice to
|
||||||
|
@ -38,27 +38,27 @@ list</a>.</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>check out the latest files from CVS</li>
|
<li>check out the latest files from CVS</li>
|
||||||
<li>log on to the local localizer at
|
<li>log on to the local localizer at
|
||||||
<code>http://YOURSERVER/livesupport/localizer</code></li>
|
<code>http://YOURSERVER/campcaster/localizer</code></li>
|
||||||
<li>send the changed <code>locals.??_??.xml</code> file(s) from the folders
|
<li>send the changed <code>locals.??_??.xml</code> file(s) from the folders
|
||||||
<ul>
|
<ul>
|
||||||
<li><code><livesupport-cvs>/modules/htmlUI/var/</code> and</li>
|
<li><code><campcaster-cvs>/modules/htmlUI/var/</code> and</li>
|
||||||
<li><code><livesupport-cvs>/modules/htmlUI/var/localizer/</code></li>
|
<li><code><campcaster-cvs>/modules/htmlUI/var/localizer/</code></li>
|
||||||
</ul>
|
</ul>
|
||||||
to the <a href="http://sympa.mdlf.org/wws/info/livesupport-dev">developers'
|
to the <a href="http://sympa.mdlf.org/wws/info/campcaster-dev">developers'
|
||||||
mailing list</a>.</li>
|
mailing list</a>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</p>
|
</p>
|
||||||
</font>
|
</font>
|
||||||
|
|
||||||
<h1>Localization of LiveSupport Studio</h1>
|
<h1>Localization of Campcaster Studio</h1>
|
||||||
<p>
|
<p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>If editing an existing language: download the latest version of the
|
<li>If editing an existing language: download the latest version of the
|
||||||
language file ??.txt or ??_??.txt from
|
language file ??.txt or ??_??.txt from
|
||||||
<a href="http://code.campware.org/projects/livesupport/browser/trunk/livesupport/src/products/gLiveSupport/var/">this directory</a> (click on the file
|
<a href="http://code.campware.org/projects/campcaster/browser/trunk/campcaster/src/products/gLiveSupport/var/">this directory</a> (click on the file
|
||||||
name, scroll down to the bottom, right-click on Plain Text and choose
|
name, scroll down to the bottom, right-click on Plain Text and choose
|
||||||
Save Target As or Save Link As, depending on your browser);
|
Save Target As or Save Link As, depending on your browser);
|
||||||
<p>if adding a new language: download <a href="http://code.campware.org/projects/livesupport/file/trunk/livesupport/src/products/gLiveSupport/var/root.txt?format=txt">the latest version of root.txt</a>;</li>
|
<p>if adding a new language: download <a href="http://code.campware.org/projects/campcaster/file/trunk/campcaster/src/products/gLiveSupport/var/root.txt?format=txt">the latest version of root.txt</a>;</li>
|
||||||
<li>edit the texts between the "..."s;</li>
|
<li>edit the texts between the "..."s;</li>
|
||||||
<li>save it as a plain text file in UTF-8 encoding.
|
<li>save it as a plain text file in UTF-8 encoding.
|
||||||
Please do not send Word documents or files in other encodings.</li>
|
Please do not send Word documents or files in other encodings.</li>
|
||||||
|
|
Loading…
Reference in New Issue