Mercurial > forge
changeset 2683:9da47715addc octave-forge
HTML is more standard compliant
| author | hauberg |
|---|---|
| date | Sat, 14 Oct 2006 16:44:15 +0000 |
| parents | 3f938458f716 |
| children | be862d57cb25 |
| files | admin/get_contents admin/make_index admin/template.ndev www/FAQ.in www/build-www.py www/developers.in www/translation.in |
| diffstat | 7 files changed, 165 insertions(+), 175 deletions(-) [+] |
line wrap: on
line diff
--- a/admin/get_contents Sat Oct 14 15:09:33 2006 +0000 +++ b/admin/get_contents Sat Oct 14 16:44:15 2006 +0000 @@ -114,14 +114,14 @@ my $dir = $1; my $file = $2; $dir =~ s{^\./}{}; # strip leading ./ - print README "\t<li> <b><tt>$dir/</tt></b><br>\n"; + print README "\t<li> <b><tt>$dir/</tt></b><br/>\n"; foreach my $line (@c) { # use fixed font for words that end with / # (ie, directory names). $line =~ s{\s(\S+/)([.,\s])}{ <tt>$1</tt>$2}g; print README "\t$line"; } - print README "\n"; + print README "</li>\n"; } $added_contents = 1; } else {
--- a/admin/make_index Sat Oct 14 15:09:33 2006 +0000 +++ b/admin/make_index Sat Oct 14 16:44:15 2006 +0000 @@ -26,7 +26,7 @@ #my $OCTAVECMD = "LD_LIBRARY_PATH=$OCTAVE/src/:$OCTAVE/liboctave:$OCTAVE/libcruft $OCTAVE/src/octave -q"; #my $OCTAVEINIT = "path='.:$OCTAVE/src//:$OCTAVE/scripts//'; suppress_verbose_help_message = 1;"; my $OCTAVECMD = "octave -q"; -my $OCTAVEINIT = "suppress_verbose_help_message = 1;"; +my $OCTAVEINIT = "suppress_verbose_help_message(1);"; # Links to octave/octave-forge web CVS my $OCTAVECVS = "http://www.octave.org/cgi-bin/viewcvs.cgi/~checkout~/octave"; @@ -868,7 +868,8 @@ my $package; my $title; my $desc = sprintf("%s/DESCRIPTION", $packdir); - open(IN, $desc) or die "Cannot read $desc: $!\n"; + #open(IN, $desc) or die "Cannot read $desc: $!\n"; + open(IN, $desc) or return; while(<IN>) { if (/^[Nn]ame:/) { chomp;
--- a/admin/template.ndev Sat Oct 14 15:09:33 2006 +0000 +++ b/admin/template.ndev Sat Oct 14 16:44:15 2006 +0000 @@ -10,19 +10,19 @@ <h3>Requirements</h3> -To contribute your .m files, C++, C, or Fortran code to the GNU Octave -Repository (octave-forge) you need to +<p>To contribute your .m files, C++, C, or Fortran code to the GNU Octave +Repository (octave-forge) you need to</p> <ul> - <li> have an account on SourceForge, - <li> be registered as an octave-forge developer, - <li> have <a href="http://www.cvshome.org/">CVS</a> + <li>have an account on SourceForge,</li> + <li>be registered as an octave-forge developer,</li> + <li>have <a href="http://www.cvshome.org/">CVS</a> installed on the computer from which you - will submit contributions, and - <li> have the secure shell, - <a href="http://www.openssh.com/"><tt>ssh</tt></a>, installed - on your computer. + will submit contributions, and</li> + <li>have the secure shell, + <a href="http://www.openssh.com/"><tt>ssh</tt></a>, installed + on your computer.</li> </ul> -The first two requirements are easy but may take a few days. +<p>The first two requirements are easy but may take a few days. If you don't already have one, request a SourceForge (SF) account <a href="http://sourceforge.net/account/register.php"> here</a>. To register as a developer send a request @@ -35,54 +35,52 @@ installed on your system. If they aren't, you will need to find prebuilt packages for them or download their -source codes and build them. +source codes and build them.</p> <h3>Create a SF home directory</h3> <p> If you've never submitted code to a SourceForge project before, create your home directory by -logging onto the octave-forge account with <tt>ssh</tt>: +logging onto the octave-forge account with <tt>ssh</tt>:</p> <pre> - $ ssh -l <FONT COLOR="#800000"><i>sflogin</i></FONT> octave.cvs.sourceforge.net - Password: <FONT COLOR="#800000"><i>your SF password</i></FONT> + $ ssh -l <span style="color: #800000;"><i>sflogin</i></span> octave.cvs.sourceforge.net + Password: <span style="color: #800000;"><i>your SF password</i></span> </pre> -Although SF will only show you a message-of-the-day screen then log +<p>Although SF will only show you a message-of-the-day screen then log you out, this process has the useful side effect of creating a home directory for you if one doesn't already exist. Some CVS commands will fail -if you do not have a home directory on SF. +if you do not have a home directory on SF.</p> <h3>Download the latest octave-forge distribution</h3> -CVS expects the +<p>CVS expects the code you plan to submit to reside in a directory within the existing octave-forge directory structure. You will therefore need to download a copy of the latest octave-forge distribution to work in. Change directories to a place you want to put the code, then issue the CVS <i>checkout</i> -(abreviated as 'co') command: +(abreviated as 'co') command:</p> <pre> - $ cd <FONT COLOR="#800000"><i>working_directory</i></FONT> + $ cd <span style="color: #800000;"><i>working_directory</i></span> $ export CVS_RSH=ssh - $ cvs -d:ext:<FONT COLOR="#800000"><i>sflogin</i></FONT>@octave.cvs.sourceforge.net:/cvsroot/octave co octave-forge + $ cvs -d:ext:<span style="color: #800000;"><i>sflogin</i></span>@octave.cvs.sourceforge.net:/cvsroot/octave co octave-forge </pre> <h3>Where does your code belong?</h3> - -Put your file(s) in a subdirectory under the <tt>octave-forge/</tt> +<p>Put your file(s) in a subdirectory under the <tt>octave-forge/</tt> directory. Here are some guidelines to help you decide where your -code belongs: +code belongs:</p> <ul> >>>INSERT CONTENTS HERE<<< </ul> <h3>Add a copyright notice</h3> -<p> -Each file in octave-forge must contain a copyright notice. +<p>Each file in octave-forge must contain a copyright notice. If you wish to release your code under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a> -, insert the following text at the top of your file: +, insert the following text at the top of your file:</p> <pre> -## Copyright (C) <FONT COLOR="#800000"><i>year</i></FONT> <FONT COLOR="#800000"><i>Your Name</i></FONT> <<FONT COLOR="#800000"><i>your@preferred.email</i></FONT>> +## Copyright (C) <span style="color: #800000;"><i>year</i></span> <span style="color: #800000;"><i>Your Name</i></span> <<span style="color: #800000;"><i>your@preferred.email</i></span>> ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -99,22 +97,22 @@ ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA </pre> -Here are other popular open source licenses: +<p>Here are other popular open source licenses:</p> <ul> - <li> <a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser GPL</a> - <li> <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</a> - <li> <a href="http://www.opensource.org/licenses/artistic-license.html">Artistic License</a> - <li> <a href="http://www.opensource.org/licenses/bsd-license.html">BSD License</a> + <li><a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser GPL</a></li> + <li><a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</a></li> + <li><a href="http://www.opensource.org/licenses/artistic-license.html">Artistic License</a></li> + <li><a href="http://www.opensource.org/licenses/bsd-license.html">BSD License</a></li> </ul> -Consult +<p>Consult <a href="http://www.opensource.org/licenses/index.html">opensource.org</a>. -for a comprehensive list of Open Source licenses. +for a comprehensive list of Open Source licenses.</p> <h3>Package structure</h3> <p> Octave has evolved into a source repository is octave pacakges rather than a package in itself. Each sub-directory is considered to be a -package and should respect Octave's package managers file layout. +package and should respect Octave's package managers file layout.</p> <dl> <dt>package/NOINSTALL <dd> This is an optional file, whose presence tells octave-forge @@ -308,88 +306,85 @@ </dl> <h3>Submit your code!</h3> -You are now ready to upload your code to the Gnu Octave Repository. +<p>You are now ready to upload your code to the Gnu Octave Repository. Do this with two CVS commands--one to add a new entry for your file in the octave-forge catalog, and a second command -to actually upload the file: +to actually upload the file:</p> <pre> - $ cvs add <FONT COLOR="#800000"><i>files</i></FONT> - $ cvs commit <FONT COLOR="#800000"><i>files</i></FONT> + $ cvs add <span style="color: #800000;"><i>files</i></span> + $ cvs commit <span style="color: #800000;"><i>files</i></span> </pre> - -After hitting the carriage return at the end of the commit command, +<p>After hitting the carriage return at the end of the commit command, CVS will open your default editor so that you can enter comments about the commit. The first time you commit a file the comment might be something as simple as `Initial commit into CVS.' However, for all subsequent commits please add meaningful comments that explain why changes were made to the file since all comments will appear in the -changelog. Try to gather related changes into one commit command. -<p> -Aside: the default editor can be defined like so: +changelog. Try to gather related changes into one commit command.</p> + +<p>Aside: the default editor can be defined like so:</p> <pre> - $ export EDITOR=<FONT COLOR="#800000">vim</FONT> + $ export EDITOR=<span style="color: #800000;">vim</span> </pre> -<p> -If you are uploading an entire package, then put your directory into the -octave-forge tree and do the following: +<p>If you are uploading an entire package, then put your directory into the +octave-forge tree and do the following:</p> <pre> $ cd octave-forge/main - $ cvs add <FONT COLOR="#800000"><i>package</i></FONT> - $ cvs commit <FONT COLOR="#800000"><i>package</i></FONT> - $ cd <FONT COLOR="#800000"><i>package</i></FONT> + $ cvs add <span style="color: #800000;"><i>package</i></span> + $ cvs commit <span style="color: #800000;"><i>package</i></span> + $ cd <span style="color: #800000;"><i>package</i></span> $ cvs add * $ cvs commit * </pre> -You may find it easier to use the import command, especially if your +<p>You may find it easier to use the import command, especially if your package contains subdirectories. In this case, you should not put your directory into the octave-forge tree. Instead, change to the -root of your package tree and enter the following: +root of your package tree and enter the following:</p> <pre> - $ cd <FONT COLOR="#800000"><i>package</i></FONT> - $ cvs -d:ext:<FONT COLOR="#800000"><i>sflogin</i></FONT>@octave.cvs.sourceforge.net:/cvsroot/octave import -m "<FONT COLOR="#800000"><i>package name</i></FONT>" octave-forge/<FONT COLOR="#800000"><i>main/package</i></FONT> <FONT COLOR="#800000"><i>sflogin</i></FONT> start + $ cd <span style="color: #800000;"><i>package</i></span> + $ cvs -d:ext:<span style="color: #800000;"><i>sflogin</i></span>@octave.cvs.sourceforge.net:/cvsroot/octave import -m "<span style="color: #800000;"><i>package name</i></span>" octave-forge/<span style="color: #800000;"><i>main/package</i></span> <span style="color: #800000;"><i>sflogin</i></span> start </pre> -You can then fetch the new package from octave-forge as follows: +<p>You can then fetch the new package from octave-forge as follows:</p> <pre> $ cd octave-forge $ cvs -q update -d </pre> -<p> -From time to time, you will need to synchronize with CVS: +<p>From time to time, you will need to synchronize with CVS:</p> <pre> $ cd octave-forge $ cvs -q update -d </pre> -Each file will be listed with one of the following codes: +<p>Each file will be listed with one of the following codes:</p> <ul> -<li> `?' for files you created didn't add and commit. -<li> `M' for files you modified but didn't commit. +<li> `?' for files you created didn't add and commit.</li> +<li> `M' for files you modified but didn't commit.</li> <li> `C' for files which have unresolvable conflicts. Look inside the file to see what it was that couldn't be resolved. It will be clearly marked, or you -can do a cvs diff on the file to highlight the conflict. -<li> `U' for files you haven't touched but are modified on the server. +can do a cvs diff on the file to highlight the conflict.</li> +<li> `U' for files you haven't touched but are modified on the server.</li> <li> `P' for files you have modified in a way consistent with the modifications -on the server (?), e.g., because you submitted a patch for someone else to apply. +on the server (?), e.g., because you submitted a patch for someone else to apply.</li> </ul> <h3>Learn more about CVS</h3> -The few CVS commands shown here just scratch the surface of this +<p>The few CVS commands shown here just scratch the surface of this powerful versioning package. If you become an active contributor you will benefit from learning more CVS commands and understanding how CVS works. The <a href="http://cvsbook.red-bean.com/cvsbook.html"> -CVS Book</a> is a great place to begin your exploration. +CVS Book</a> is a great place to begin your exploration.</p> <h3>Join the developers' mailing list</h3> -Finally, consider joining the octave-forge developer's +<p>Finally, consider joining the octave-forge developer's <a href="http://lists.sourceforge.net/lists/listinfo/octave-dev"> mailing list</a>. It is very low traffic. It is used to announce pending releases of octave-forge and discuss issues related to working with octave-forge. Discussion of the functions in -octave-forge mostly occurs on the primary octave mailing lists. +octave-forge mostly occurs on the primary octave mailing lists.</p> __TRAILER__
--- a/www/FAQ.in Sat Oct 14 15:09:33 2006 +0000 +++ b/www/FAQ.in Sat Oct 14 16:44:15 2006 +0000 @@ -3,12 +3,12 @@ <p> The following page contains some questions often asked by users and developers along with the answers. You'll find the following topics covered by this page +</p> <ul> <li><a href="#packages">Using the packages</a></li> <li><a href="#about">About Octave-Forge</a></li> <li><a href="#compatibility">Matlab Compatibility</a></li> </ul> -</p> <h2 id="packages">Using the packages</h2> <h3 class="question" id="install">How do I install a package?</h3> @@ -16,9 +16,9 @@ web page and clicking <em>download</em>. Then start Octave and go to the directory where you placed the downloaded package using the <em>cd</em> command. Then type - </p><p> + </p> <code>pkg install package_file_name.tar.gz</code> - </p><p> + <p> where <em>package_file_name.tar.gz</em> is the file name of the package you downloaded. </p> @@ -31,16 +31,16 @@ </p> <p>If you don't want to install the dependencies of a package, you can use the <em>-no-deps</em> flag for the <em>pkg</em> command - </p><p> + </p> <code>pkg install -no-deps package_file_name.tar.gz</code> - </p><p> + <p> If you choose to do this, you might experience problems with the package. So in general the <em>-no-deps</em> is not recommended. </p> <h3 class="question">How do I uninstall a package?</h3> <p>You simply type</p> - <p><code>pkg uninstall package_name</code</p> + <code>pkg uninstall package_name</code> <p>where <em>package_name</em> is the name of the package you want to uninstall (e.g. <em>image</em>).</p>
--- a/www/build-www.py Sat Oct 14 15:09:33 2006 +0000 +++ b/www/build-www.py Sat Oct 14 16:44:15 2006 +0000 @@ -256,7 +256,7 @@ index.write('<p>The following packages are currently available in the repository.\n'); index.write("If you don't know how to install the packages please read the\n"); index.write('relevant part of the <a href="FAQ.html#install">FAQ</a>.\n</p>'); - index.write('<p>Currently Octave-Forge is divided into seperate repositories\n'); + index.write('<p>Currently Octave-Forge is divided into seperate repositories</p>\n'); index.write('<ul><li><a href="#main">Main repository</a> contains packages that\n'); index.write('are well tested and suited for most users.</li>\n'); index.write('<li><a href="#extra">Extra packages</a> contains packages that\n'); @@ -292,7 +292,7 @@ index.write(' <table class="package"><tr>\n'); index.write(' <td><b><a href="javascript:fold(\'' + n + '\');" class="package_head_link">' + desc['name'] + '</a></b></td>\n'); index.write(' <td style="text-align: right;">» <a href="' + outdir + '/index.html" class="package_link">details</a> |\n'); - index.write(' <a class="package_link" href="__PACKAGE__/' + archiv + '?download">download</a></p>\n'); + index.write(' <a class="package_link" href="__PACKAGE__/' + archiv + '?download">download</a>\n'); index.write(' </td>\n'); index.write(' </tr></table>\n'); @@ -305,7 +305,7 @@ index.write(' <table class="package"><tr>\n'); index.write(' <td><b><a href="javascript:unfold(\'' + n + '\');" class="package_head_link">' + desc['name'] + '</a></b></td>\n'); index.write(' <td style="text-align: right;">» <a href="' + outdir + '/index.html" class="package_link">details</a> |\n'); - index.write(' <a class="package_link" href="__PACKAGE__/' + archiv + '?download">download</a></p>\n'); + index.write(' <a class="package_link" href="__PACKAGE__/' + archiv + '?download">download</a>\n'); index.write(' </td>\n'); index.write(' </tr></table>\n');
--- a/www/developers.in Sat Oct 14 15:09:33 2006 +0000 +++ b/www/developers.in Sat Oct 14 16:44:15 2006 +0000 @@ -4,19 +4,19 @@ <h3>Requirements</h3> -To contribute your .m files, C++, C, or Fortran code to the GNU Octave -Repository (octave-forge) you need to +<p>To contribute your .m files, C++, C, or Fortran code to the GNU Octave +Repository (octave-forge) you need to</p> <ul> - <li> have an account on SourceForge, - <li> be registered as an octave-forge developer, - <li> have <a href="http://www.cvshome.org/">CVS</a> + <li>have an account on SourceForge,</li> + <li>be registered as an octave-forge developer,</li> + <li>have <a href="http://www.cvshome.org/">CVS</a> installed on the computer from which you - will submit contributions, and - <li> have the secure shell, - <a href="http://www.openssh.com/"><tt>ssh</tt></a>, installed - on your computer. + will submit contributions, and</li> + <li>have the secure shell, + <a href="http://www.openssh.com/"><tt>ssh</tt></a>, installed + on your computer.</li> </ul> -The first two requirements are easy but may take a few days. +<p>The first two requirements are easy but may take a few days. If you don't already have one, request a SourceForge (SF) account <a href="http://sourceforge.net/account/register.php"> here</a>. To register as a developer send a request @@ -29,54 +29,53 @@ installed on your system. If they aren't, you will need to find prebuilt packages for them or download their -source codes and build them. +source codes and build them.</p> <h3>Create a SF home directory</h3> <p> If you've never submitted code to a SourceForge project before, create your home directory by -logging onto the octave-forge account with <tt>ssh</tt>: +logging onto the octave-forge account with <tt>ssh</tt>:</p> <pre> - $ ssh -l <FONT COLOR="#800000"><i>sflogin</i></FONT> octave.cvs.sourceforge.net - Password: <FONT COLOR="#800000"><i>your SF password</i></FONT> + $ ssh -l <span style="color: #800000;"><i>sflogin</i></span> octave.cvs.sourceforge.net + Password: <span style="color: #800000;"><i>your SF password</i></span> </pre> -Although SF will only show you a message-of-the-day screen then log +<p>Although SF will only show you a message-of-the-day screen then log you out, this process has the useful side effect of creating a home directory for you if one doesn't already exist. Some CVS commands will fail -if you do not have a home directory on SF. +if you do not have a home directory on SF.</p> <h3>Download the latest octave-forge distribution</h3> -CVS expects the +<p>CVS expects the code you plan to submit to reside in a directory within the existing octave-forge directory structure. You will therefore need to download a copy of the latest octave-forge distribution to work in. Change directories to a place you want to put the code, then issue the CVS <i>checkout</i> -(abreviated as 'co') command: +(abreviated as 'co') command:</p> <pre> - $ cd <FONT COLOR="#800000"><i>working_directory</i></FONT> + $ cd <span style="color: #800000;"><i>working_directory</i></span> $ export CVS_RSH=ssh - $ cvs -d:ext:<FONT COLOR="#800000"><i>sflogin</i></FONT>@octave.cvs.sourceforge.net:/cvsroot/octave co octave-forge + $ cvs -d:ext:<span style="color: #800000;"><i>sflogin</i></span>@octave.cvs.sourceforge.net:/cvsroot/octave co octave-forge </pre> <h3>Where does your code belong?</h3> - -Put your file(s) in a subdirectory under the <tt>octave-forge/</tt> +<p>Put your file(s) in a subdirectory under the <tt>octave-forge/</tt> directory. Here are some guidelines to help you decide where your -code belongs: +code belongs:</p> <ul> - <li> <b><tt>admin/</tt></b><br> + <li> <b><tt>admin/</tt></b><br/> Contains files and scripts used to administer the octave-forge website and build the release files. Nothing in here is needed by octave-forge users. - - <li> <b><tt>doc/</tt></b><br> +</li> + <li> <b><tt>doc/</tt></b><br/> Documentation for octave in general. Documentation for specific packages goes into the <tt>doc/</tt> subdirectory of the individual package directories. There are no standards for documentation at this time. - - <li> <b><tt>extra/</tt></b><br> +</li> + <li> <b><tt>extra/</tt></b><br/> Packages which: <ul> <li> are too narrow in scope for <tt>main/</tt>, or <li> act as alternatives for functions in <tt>main/</tt>, or @@ -86,16 +85,16 @@ <li> require patches to Octave, or <li> are designed for older versions of Octave, or <li> haven't been tested enough. -</ul> - <li> <b><tt>main/</tt></b><br> +</ul></li> + <li> <b><tt>main/</tt></b><br/> Packages which may eventually be included in the main octave distribution. As such, they should follow Octave conventions. The octave-forge CVS tree should be the primary development/release site. All functions should work with the latest Octave interpreter without any special compilation switches or patches applied. - - <li> <b><tt>nonfree/</tt></b><br> +</li> + <li> <b><tt>nonfree/</tt></b><br/> Packages which are not freely modifiable and redistributable with modifications, or which depend on code which is not free. This includes functions which only permit non-commercial @@ -105,24 +104,23 @@ redistributable for non-commercial use. Functions of unknown license should not be included anywhere, since no license implies default license implies no rights to redistribute. - - <li> <b><tt>packages/</tt></b><br> +</li> + <li> <b><tt>packages/</tt></b><br/> This is the target directory, where the source packages are placed. It is also the directory where the test code is run for each of the packages and where the source RPMs are automatically built. There should be no reason for the user to add files to this directory - +</li> </ul> <h3>Add a copyright notice</h3> -<p> -Each file in octave-forge must contain a copyright notice. +<p>Each file in octave-forge must contain a copyright notice. If you wish to release your code under the GNU <a href="http://www.gnu.org/licenses/gpl.html">GPL</a> -, insert the following text at the top of your file: +, insert the following text at the top of your file:</p> <pre> -## Copyright (C) <FONT COLOR="#800000"><i>year</i></FONT> <FONT COLOR="#800000"><i>Your Name</i></FONT> <<FONT COLOR="#800000"><i>your@preferred.email</i></FONT>> +## Copyright (C) <span style="color: #800000;"><i>year</i></span> <span style="color: #800000;"><i>Your Name</i></span> <<span style="color: #800000;"><i>your@preferred.email</i></span>> ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -139,22 +137,22 @@ ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA </pre> -Here are other popular open source licenses: +<p>Here are other popular open source licenses:</p> <ul> - <li> <a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser GPL</a> - <li> <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</a> - <li> <a href="http://www.opensource.org/licenses/artistic-license.html">Artistic License</a> - <li> <a href="http://www.opensource.org/licenses/bsd-license.html">BSD License</a> + <li><a href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser GPL</a></li> + <li><a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</a></li> + <li><a href="http://www.opensource.org/licenses/artistic-license.html">Artistic License</a></li> + <li><a href="http://www.opensource.org/licenses/bsd-license.html">BSD License</a></li> </ul> -Consult +<p>Consult <a href="http://www.opensource.org/licenses/index.html">opensource.org</a>. -for a comprehensive list of Open Source licenses. +for a comprehensive list of Open Source licenses.</p> <h3>Package structure</h3> <p> Octave has evolved into a source repository is octave pacakges rather than a package in itself. Each sub-directory is considered to be a -package and should respect Octave's package managers file layout. +package and should respect Octave's package managers file layout.</p> <dl> <dt>package/NOINSTALL <dd> This is an optional file, whose presence tells octave-forge @@ -348,88 +346,85 @@ </dl> <h3>Submit your code!</h3> -You are now ready to upload your code to the Gnu Octave Repository. +<p>You are now ready to upload your code to the Gnu Octave Repository. Do this with two CVS commands--one to add a new entry for your file in the octave-forge catalog, and a second command -to actually upload the file: +to actually upload the file:</p> <pre> - $ cvs add <FONT COLOR="#800000"><i>files</i></FONT> - $ cvs commit <FONT COLOR="#800000"><i>files</i></FONT> + $ cvs add <span style="color: #800000;"><i>files</i></span> + $ cvs commit <span style="color: #800000;"><i>files</i></span> </pre> - -After hitting the carriage return at the end of the commit command, +<p>After hitting the carriage return at the end of the commit command, CVS will open your default editor so that you can enter comments about the commit. The first time you commit a file the comment might be something as simple as `Initial commit into CVS.' However, for all subsequent commits please add meaningful comments that explain why changes were made to the file since all comments will appear in the -changelog. Try to gather related changes into one commit command. -<p> -Aside: the default editor can be defined like so: +changelog. Try to gather related changes into one commit command.</p> + +<p>Aside: the default editor can be defined like so:</p> <pre> - $ export EDITOR=<FONT COLOR="#800000">vim</FONT> + $ export EDITOR=<span style="color: #800000;">vim</span> </pre> -<p> -If you are uploading an entire package, then put your directory into the -octave-forge tree and do the following: +<p>If you are uploading an entire package, then put your directory into the +octave-forge tree and do the following:</p> <pre> $ cd octave-forge/main - $ cvs add <FONT COLOR="#800000"><i>package</i></FONT> - $ cvs commit <FONT COLOR="#800000"><i>package</i></FONT> - $ cd <FONT COLOR="#800000"><i>package</i></FONT> + $ cvs add <span style="color: #800000;"><i>package</i></span> + $ cvs commit <span style="color: #800000;"><i>package</i></span> + $ cd <span style="color: #800000;"><i>package</i></span> $ cvs add * $ cvs commit * </pre> -You may find it easier to use the import command, especially if your +<p>You may find it easier to use the import command, especially if your package contains subdirectories. In this case, you should not put your directory into the octave-forge tree. Instead, change to the -root of your package tree and enter the following: +root of your package tree and enter the following:</p> <pre> - $ cd <FONT COLOR="#800000"><i>package</i></FONT> - $ cvs -d:ext:<FONT COLOR="#800000"><i>sflogin</i></FONT>@octave.cvs.sourceforge.net:/cvsroot/octave import -m "<FONT COLOR="#800000"><i>package name</i></FONT>" octave-forge/<FONT COLOR="#800000"><i>main/package</i></FONT> <FONT COLOR="#800000"><i>sflogin</i></FONT> start + $ cd <span style="color: #800000;"><i>package</i></span> + $ cvs -d:ext:<span style="color: #800000;"><i>sflogin</i></span>@octave.cvs.sourceforge.net:/cvsroot/octave import -m "<span style="color: #800000;"><i>package name</i></span>" octave-forge/<span style="color: #800000;"><i>main/package</i></span> <span style="color: #800000;"><i>sflogin</i></span> start </pre> -You can then fetch the new package from octave-forge as follows: +<p>You can then fetch the new package from octave-forge as follows:</p> <pre> $ cd octave-forge $ cvs -q update -d </pre> -<p> -From time to time, you will need to synchronize with CVS: +<p>From time to time, you will need to synchronize with CVS:</p> <pre> $ cd octave-forge $ cvs -q update -d </pre> -Each file will be listed with one of the following codes: +<p>Each file will be listed with one of the following codes:</p> <ul> -<li> `?' for files you created didn't add and commit. -<li> `M' for files you modified but didn't commit. +<li> `?' for files you created didn't add and commit.</li> +<li> `M' for files you modified but didn't commit.</li> <li> `C' for files which have unresolvable conflicts. Look inside the file to see what it was that couldn't be resolved. It will be clearly marked, or you -can do a cvs diff on the file to highlight the conflict. -<li> `U' for files you haven't touched but are modified on the server. +can do a cvs diff on the file to highlight the conflict.</li> +<li> `U' for files you haven't touched but are modified on the server.</li> <li> `P' for files you have modified in a way consistent with the modifications -on the server (?), e.g., because you submitted a patch for someone else to apply. +on the server (?), e.g., because you submitted a patch for someone else to apply.</li> </ul> <h3>Learn more about CVS</h3> -The few CVS commands shown here just scratch the surface of this +<p>The few CVS commands shown here just scratch the surface of this powerful versioning package. If you become an active contributor you will benefit from learning more CVS commands and understanding how CVS works. The <a href="http://cvsbook.red-bean.com/cvsbook.html"> -CVS Book</a> is a great place to begin your exploration. +CVS Book</a> is a great place to begin your exploration.</p> <h3>Join the developers' mailing list</h3> -Finally, consider joining the octave-forge developer's +<p>Finally, consider joining the octave-forge developer's <a href="http://lists.sourceforge.net/lists/listinfo/octave-dev"> mailing list</a>. It is very low traffic. It is used to announce pending releases of octave-forge and discuss issues related to working with octave-forge. Discussion of the functions in -octave-forge mostly occurs on the primary octave mailing lists. +octave-forge mostly occurs on the primary octave mailing lists.</p> __TRAILER__
--- a/www/translation.in Sat Oct 14 15:09:33 2006 +0000 +++ b/www/translation.in Sat Oct 14 16:44:15 2006 +0000 @@ -33,11 +33,10 @@ <p>Translators can also add their name and email to the translated file.</p> -<p>The top line will look something like: +<p>The top line will look something like:</p> <pre> mdf="d52f61a8b12616e7b99f7cd5ecbf18fb";rev="1.1";by="I.M. Translator <im.translator@gmail.com>" </pre> -</p> <h2>Downloading and installing</h2> @@ -53,7 +52,7 @@ <li>Send a message to <a href="mailto:octave-dev@lists.sf.net">octave-dev@lists.sf.net</a> with your SFID. Ask to be included in the translation project.</li> -<li>Check out the current octave language sources for your language:<br> +<li>Check out the current octave language sources for your language:<br/> <pre> export SFID=your sourceforge id export CVS_RSH=ssh @@ -76,29 +75,29 @@ <p>After each translation, run 'octlang tag file.ZZ' (not yet written) which computes the md5 sum in the base directory and tags the top line of -the translation with +the translation with</p> <pre> mdf="$MD5SUM";rev="$REV";by="$OCTAVE_TRANSLATOR" </pre> -where MD5SUM and REV are computed by the script and OCTAVE_TRANSLATOR is +<p>where MD5SUM and REV are computed by the script and OCTAVE_TRANSLATOR is exported from the shell. </p> <h2>Maintaining your translations</h2> <p>As octave evolves you will need to keep your translations up to date. The -script octave-lang/admin/octlang (not yet written) can help you: +script octave-lang/admin/octlang (not yet written) can help you:</p> <dl> -<dt>octlang missing -<dd>walk the current subtree listing all translations which are missing. -<dt>octlang updated -<dd>walk the current subtree listing all translations which are out of date. -<dt>octlang diff file.ZZ +<dt>octlang missing</dt> +<dd>walk the current subtree listing all translations which are missing.</dd> +<dt>octlang updated</dt> +<dd>walk the current subtree listing all translations which are out of date.</dd> +<dt>octlang diff file.ZZ</dt> <dd>list differences between the original text which was translated and the -current text in base. -<dt>octlang tag file.ZZ +current text in base.</dd> +<dt>octlang tag file.ZZ</dt> <dd>tag file.ZZ as up to date, marking the header with the current md5 sum -and version number from base. +and version number from base.</dd> </dl> <h2>Updating base</h2>