On Sat, 13 Jan 2007, Peter Keung wrote: > Modified: trunk/Archive/docs/tutorial.txt > =================================================================== > --- trunk/Archive/docs/tutorial.txt 2007-01-12 23:13:19 UTC (rev 4500) > +++ trunk/Archive/docs/tutorial.txt 2007-01-13 00:00:08 UTC (rev 4501)
<snip> > @@ -18,17 +18,17 @@ > The following list sums up the most important classes: > > ezcArchive > - This class provides the main API for accessing or creating a non-existing > - Tar or Zip archive. The Archive is designed that it provides methods for > - extracting entries (files, directories, symbolic links, etc), appending > - entries, or removing entries on the open archive. > + This class provides the main API for accessing or creating a > + Tar or Zip archive. Archive provides methods for > + extracting entries (files, directories, symbolic links and so on), > appending > + entries and removing entries. Instead of "Archive" I would use "the Archive component". > @@ -39,27 +39,27 @@ > > The following examples demonstrate how to use the Archive component. > > -Extracting a TAR-archive > +Extracting a Tar-archive > ------------------------ > > -The TAR format has more than one standard. The most common formats are: > +The Tar format has more than one standard. The most common formats are: > > - Unix V7 > - Ustar > - POSIX > - Gnu > > -Each format can be extracted from the archive. Appending entries to the > archive > -is only available for Unix V7 and Ustar format. > +Archive can extract from any of these formats. Appending entries to the > archive > +is only available for the Unix V7 and Ustar formats. Again, I would use "the Archive component" instead of just "Archive" here. > > -Extracting an Archive comes in two flavors: > +Extracting entries can occur in two ways: > > - ezcArchive->extract(), extracts all entries from the archive. > - ezcArchive->extractCurrent(), extracts only the current entry. > > -The Archive can be treated like an iterator. > -After opening the archive, it points to the first entry. The iterator can be > -moved using the ezcArchive->next() and ezcArchive->rewind() to move to the > next > +Archive can be treated like an iterator. That's a bit vague I think. I suggest to change it to something like: An ezcArchive object can be used like an iterator. > +After opening the file, it points to the first entry. The iterator can be > +moved using ezcArchive->next() and ezcArchive->rewind() to move to the next > entry or go back to the first entry. > > The next example demonstrates how to extract an entire archive file-by-file: > @@ -67,16 +67,16 @@ > .. include:: tutorial_extract.php > :literal: > > -First the tutorial_autoload.php is included. The included file loads the > -correct php files for the archive package. Hereafter the time zone is set to > -"UTC". The archive uses some date functions and without a time zone PHP may > -show some warnings. > +First, tutorial_autoload.php is included. The included file loads the > +correct php files for the Archive package. Hereafter the time zone is set to > +"UTC". The archive uses some date functions and might therefore produce > errors > +if the time zone is not specified. Instead of "errors" it should say "warnings", as in PHP speak an "error" aborts the script (which is not the case here). regards, Derick -- svn-components mailing list svn-components@lists.ez.no http://lists.ez.no/mailman/listinfo/svn-components
