diff options
| author | Norbert Preining <norbert@preining.info> | 2021-09-27 03:01:47 +0000 |
|---|---|---|
| committer | Norbert Preining <norbert@preining.info> | 2021-09-27 03:01:47 +0000 |
| commit | 30b8c834b941b4c6311906369ce5008fd2e72bf8 (patch) | |
| tree | b3c424c023951c9ef64844d8d9b99300e597a5a3 /help | |
| parent | 1fdd813fb19929aee2dfa99b2d04cb16c9f9e902 (diff) | |
CTAN sync 202109270301
Diffstat (limited to 'help')
| -rw-r--r-- | help/ctan/CTAN-upload-addendum.html | 956 |
1 files changed, 499 insertions, 457 deletions
diff --git a/help/ctan/CTAN-upload-addendum.html b/help/ctan/CTAN-upload-addendum.html index 728f2a62fa..15fc817a68 100644 --- a/help/ctan/CTAN-upload-addendum.html +++ b/help/ctan/CTAN-upload-addendum.html @@ -10,7 +10,7 @@ --> <link rel="stylesheet" type="text/css" href="https://www.tug.org/tugstyle.css" /> <meta name="author" content="Petra Rübe-Pugliese" /> - <meta name="date" content="2021-09-25" /> + <meta name="date" content="2021-09-26" /> <meta http-equiv="content-type" content="text/html; charset=us-ascii" /> <style type="text/css"> .highlight { color:navy;} @@ -120,7 +120,8 @@ as possible, regardless of the position of the individual files in a “real” TeX system. - <br/> + </p> + <p> We do however not impose any definite upper limit on the number of directory levels in a package's layout @@ -443,7 +444,7 @@ <em>within every single package</em>. Ambiguity is never a good thing, and it may prove harmful in unexpected situations. - <br /> + — (b) Let us remind you that there are operating systems unable to distinguish between <tt>myfile</tt> and @@ -469,7 +470,7 @@ Conditions on package ids: </strong> </a> - <br/> + <p> Every CTAN package is uniquely identified by its “<span class="highlight">package id</span>”, which appears, for instance, as the last part in URLs @@ -477,6 +478,7 @@ <a href="https://ctan.org/pkg/geometry">https://ctan.org/pkg/geometry</a> (here “geometry” is the package's <em>id</em>.) + </p> <ol style="list-style-type:lower-alpha;"> <li class="kleinerabstandoben"> <a id="packageidslikefilenames"></a> @@ -487,30 +489,33 @@ </li> <li class="kleinerabstandoben"> <a id="packageidrestriction"></a> - Moreover, package ids have to be all - <span class="highlight">lowercase</span>, - and they must - <span class="highlight">not start with a digit</span>. - <br/> - (To ease some of the harshness of this particular rule, - <span class="highlight">package <a id="packagenames"><em>names</em></a></span> - have been introduced which can be seen - at the beginning of the title line of their - “CTAN home page”. - For instance, at the top of - <a href="https://ctan.org/pkg/arsclassica">https://ctan.org/pkg/arsclassica</a> - you see “ArsClassica”, - at the top of - <a href="https://ctan.org/pkg/mathtype">https://ctan.org/pkg/mathtype</a> - you see “MathType”, - at the top of - <a href="https://ctan.org/pkg/one2many">https://ctan.org/pkg/one2many</a> - you see “12many”, etc. - Of course, the CTAN team <em>prefer</em>, - for the sake of simplicity, to have - “package name = package id”, - but small variants like CamelCase are accepted - for the “names”.) + <p> + Moreover, package ids have to be all + <span class="highlight">lowercase</span>, + and they must + <span class="highlight">not start with a digit</span>. + </p> + <p> + (To ease some of the harshness of this particular rule, + <span class="highlight">package <a id="packagenames"><em>names</em></a></span> + have been introduced which can be seen + at the beginning of the title line of their + “CTAN home page”. + For instance, at the top of + <a href="https://ctan.org/pkg/arsclassica">https://ctan.org/pkg/arsclassica</a> + you see “ArsClassica”, + at the top of + <a href="https://ctan.org/pkg/mathtype">https://ctan.org/pkg/mathtype</a> + you see “MathType”, + at the top of + <a href="https://ctan.org/pkg/one2many">https://ctan.org/pkg/one2many</a> + you see “12many”, etc. + Of course, the CTAN team <em>prefer</em>, + for the sake of simplicity, to have + “package name = package id”, + but small variants like CamelCase are accepted + for the “names”.) + </p> </li> <li class="kleinerabstandoben"> CTAN and TeX Live have a preference for @@ -576,22 +581,24 @@ Version identifier: </strong> </a> - <br /> - Every submission of every CTAN package has to contain a - “<span class="highlight">version identifier</span>” - that permits to distinguish this version - of the package from earlier or later ones. - (Mind that what counts here are the actual - <em>installations</em> on the archive; - submissions that were for some reason refused - and never installed may be neglected.) + <p> + Every submission of every CTAN package has to contain a + “<span class="highlight">version identifier</span>” + that permits to distinguish this version + of the package from earlier or later ones. + (Mind that what counts here are the actual + <em>installations</em> on the archive; + submissions that were for some reason refused + and never installed may be neglected.) - This identifier should of course coincide - with the one you will later enter into - the “Version” field of the - <a href="https://ctan.org/upload">upload form</a>. - <br /> - This version identifier may consist of + This identifier should of course coincide + with the one you will later enter into + the “Version” field of the + <a href="https://ctan.org/upload">upload form</a>. + </p> + <p> + This version identifier may consist of + </p> <ol style="list-style-type:lower-roman;"> <li> Either (only) a version @@ -614,45 +621,49 @@ the aforementioned data. </li> </ol> - For - <span class="highlight">simple LaTeX packages</span>, - the optional argument of - the <tt>\ProvidesPackage</tt> - or <tt>\ProvidesClass</tt> - command of the <tt>.sty</tt> or <tt>.cls</tt> file - should be a good place - where to put this information. - <br /> - For <span class="highlight">bundles</span> - that consist of various files - with possibly different version identifiers - of their own, - the whole bundle should be marked - with a “bundle version identifier” referring to - the bundle <em>as a whole</em>. - A good way to achieve this - is “tagging” - the bundle with the date of the latest - change of <em>any</em> of its files. - Put this “tag” - into a place where it is easy to find, - such as - the latest entry of a <tt>Changes</tt> file, - a <tt>VERSION</tt> file, - or an easily accessible place - (preferably: the top part) - in the - <a href="#readme"><tt>README</tt></a> file. - <br/> - Please note that in our mind the - <span class="highlight">documentation</span> - is considered <em>part of</em> the “package”. - So even if “only” a tiny detail of - the documentation - (and nothing whatever in the “runtime files”!) - has changed, - the version number, if it is part of the version identifier, - has to increase at least slightly. + <p> + For + <span class="highlight">simple LaTeX packages</span>, + the optional argument of + the <tt>\ProvidesPackage</tt> + or <tt>\ProvidesClass</tt> + command of the <tt>.sty</tt> or <tt>.cls</tt> file + should be a good place + where to put this information. + </p> + <p> + For <span class="highlight">bundles</span> + that consist of various files + with possibly different version identifiers + of their own, + the whole bundle should be marked + with a “bundle version identifier” referring to + the bundle <em>as a whole</em>. + A good way to achieve this + is “tagging” + the bundle with the date of the latest + change of <em>any</em> of its files. + Put this “tag” + into a place where it is easy to find, + such as + the latest entry of a <tt>Changes</tt> file, + a <tt>VERSION</tt> file, + or an easily accessible place + (preferably: the top part) + in the + <a href="#readme"><tt>README</tt></a> file. + </p> + <p> + Please note that in our mind the + <span class="highlight">documentation</span> + is considered <em>part of</em> the “package”. + So even if “only” a tiny detail of + the documentation + (and nothing whatever in the “runtime files”!) + has changed, + the version number, if it is part of the version identifier, + has to increase at least slightly. + </p> </li> <li class="abstandoben"> @@ -661,77 +672,84 @@ Low redundancy: </strong> </a> - <br /> - Because of the well known disadvantages - of redundancy - – - especially the risk of inconsistency! - – - we try to keep it as low as possible - on the unpacked archive. - In particular … + <p> + Because of the well known disadvantages + of redundancy + – + especially the risk of inconsistency! + – + we try to keep it as low as possible + on the unpacked archive. + In particular … + </p> <ol style="list-style-type:lower-alpha;"> <li class="kleinerabstandoben"> - … - we do not wish to hold - identical copies of one and the same file - <a id="noduplicatefiles"> - (“<span class="highlight">duplicate files</span>”) - </a> - in different places, - such as for instance - <tt>README</tt> and <tt>doc/README</tt>. - <br /> - If you <em>really</em> think you need - copies of a file in other places, - then please replace these copies - with symbolic links (a.k.a. symlinks or softlinks) - pointing to the “original” file. - — - Beware: - When packing your upload file with <tt>zip</tt>, - you will have to call it - with the <tt>--symlinks</tt> option - (or something equivalent, depending on - your particular zip program) - if you do not want the symlink to be replaced - by a copy of the original file again! - <br /> - (Mind that this request concerns only the - <a href="#unpackedtree">unpacked part</a> - and that a similar recommendation does <em>not</em> - hold for the contents of <tt>.tds.zip</tt> files: - <tt>.tds.zip</tt> files are supposed to be unpacked - without problems on <em>arbitrary</em> platforms, and this - cannot be guaranteed if they contain symbolic - links!) + <p> + … + we do not wish to hold + identical copies of one and the same file + <a id="noduplicatefiles"> + (“<span class="highlight">duplicate files</span>”) + </a> + in different places, + such as for instance + <tt>README</tt> and <tt>doc/README</tt>. + </p> + <p> + If you <em>really</em> think you need + copies of a file in other places, + then please replace these copies + with symbolic links (a.k.a. symlinks or softlinks) + pointing to the “original” file. + — + Beware: + When packing your upload file with <tt>zip</tt>, + you will have to call it + with the <tt>--symlinks</tt> option + (or something equivalent, depending on + your particular zip program) + if you do not want the symlink to be replaced + by a copy of the original file again! + </p> + <p> + (Mind that this request concerns only the + <a href="#unpackedtree">unpacked part</a> + and that a similar recommendation does <em>not</em> + hold for the contents of <tt>.tds.zip</tt> files: + <tt>.tds.zip</tt> files are supposed to be unpacked + without problems on <em>arbitrary</em> platforms, and this + cannot be guaranteed if they contain symbolic + links!) + </p> </li> <li class="kleinerabstandoben"> - … - we do not wish to hold files - that can be easily - <a id="nogeneratedfiles"> - “<span class="highlight">generated</span>” - (“<span class="highlight">derived</span>”) - </a> - from other files contained in the submission. - <!-- - <br /> - --> - The standard examples of this are - <tt>.cls</tt>, <tt>.sty</tt>, <tt>.clo</tt>, - <tt>.fd</tt> or similar LaTeX files, - when they can be generated from their - <tt>.dtx</tt> source in a straightforward way. - <!-- - <br /> - Exceptions to this rule , when they cannot - be generated in a straightforward way; - example: <tt>jsclasses</tt>, - which needs a specially customized TeX system. - --> - There are however some <i>exceptions</i> to this rule: + <p> + … + we do not wish to hold files + that can be easily + <a id="nogeneratedfiles"> + “<span class="highlight">generated</span>” + (“<span class="highlight">derived</span>”) + </a> + from other files contained in the submission. + </p> + <p> + The standard examples of this are + <tt>.cls</tt>, <tt>.sty</tt>, <tt>.clo</tt>, + <tt>.fd</tt> or similar LaTeX files, + when they can be generated from their + <tt>.dtx</tt> source in a straightforward way. + </p> + <p> + <!-- + Exceptions to this rule , when they cannot + be generated in a straightforward way; + example: <tt>jsclasses</tt>, + which needs a specially customized TeX system. + --> + There are however some <i>exceptions</i> to this rule: + </p> <ul> <li> <a id="keeppdffiles"></a> @@ -743,23 +761,25 @@ alongside with their sources. </li> <li> - <a id="readmeunpacked"></a> - <a href="#readme">README files</a>: - Even in cases where they - can be generated from other sources, - we want to keep them unpacked, - as a convenient starting point - for inspecting the package. - <br/> - <a id="readmegenerated"></a> - Please note that we do <em>not</em> recommend, - and in fact would like to discourage, - “generated” README files, - mainly because we have observed that such - “generated” README files are often - stale with respect to their source <tt>.dtx</tt> - files; it is easy to forget to update them. - + <p> + <a id="readmeunpacked"></a> + <a href="#readme">README files</a>: + Even in cases where they + can be generated from other sources, + we want to keep them unpacked, + as a convenient starting point + for inspecting the package. + </p> + <p> + <a id="readmegenerated"></a> + Please note that we do <em>not</em> recommend, + and in fact would like to discourage, + “generated” README files, + mainly because we have observed that such + “generated” README files are often + stale with respect to their source <tt>.dtx</tt> + files; it is easy to forget to update them. + </p> </li> <li> <a id="generatedinsfiles"></a> @@ -777,132 +797,137 @@ No auxiliary files: </strong> </a> - <br /> - This concerns operating system specific - data (like <tt>__MACOSX</tt> directories and - <tt>.DS_Store</tt> files), - <tt>.git</tt>, - <tt>.gitignore</tt>, - <tt>.hgignore</tt>, - <tt>.hgtags</tt>, - editor backup files - (<tt>.backup</tt>, - <tt>.bak</tt>, - <tt>.sav</tt>, - <tt>.~</tt>, - …), - as well as “leftovers” - from TeX & friends and other programs - (<tt>.aux</tt> - <tt>.log</tt> - <tt>.acn</tt> - <tt>.acr</tt> - <tt>.alg</tt> - <tt>.bbl</tt> - <tt>.bcf</tt> - <tt>.blg</tt> - <tt>.brf</tt> - <tt>.cb2</tt> - <tt>.cb</tt> - <tt>.cpt</tt> - <tt>.dvi</tt> - <tt>.ent</tt> - <tt>.fdb_latexmk</tt> - <tt>.fff</tt> - <tt>.fls</tt> - <tt>.fmt</tt> - <tt>.fot</tt> - <tt>.gaux</tt> - <tt>.glg</tt> - <tt>.glo</tt> - <tt>.glog</tt> - <tt>.gls</tt> - <tt>.glsdefs</tt> - <tt>.gtex</tt> - <tt>.hd</tt> - <tt>.idv</tt> - <tt>.idx</tt> - <tt>.ilg</tt> - <tt>.ind</tt> - <tt>.lg</tt> - <tt>.loa</tt> - <tt>.lod</tt> - <tt>.lof</tt> - <tt>.lol</tt> - <tt>.los</tt> - <tt>.lot</tt> - <tt>.lox</tt> - <tt>.maf</tt> - <tt>.mlf</tt> - <tt>.mlt</tt> - <tt>.mtc</tt> - <tt>.nav</tt> - <tt>.nlg</tt> - <tt>.nlo</tt> - <tt>.nls</tt> - <tt>.o</tt> - <tt>.obj</tt> - <tt>.out</tt> - <tt>.pdfsync</tt> - <tt>.pre</tt> - <tt>.pyg</tt> - <tt>.run.xml</tt> - <tt>.snm</tt> - <tt>.soc</tt> - <tt>.spl</tt> - <tt>.sta</tt> - <tt>.swp</tt> - <tt>.synctex</tt> - <tt>.synctex.gz</tt> - <tt>.tdo</tt> - <tt>.thm</tt> - <tt>.tmb</tt> - <tt>.tmp</tt> - <tt>.toc</tt> - <tt>.tpt</tt> - <tt>.trc</tt> - <tt>.ttt</tt> - <tt>.tuc</tt> - <tt>.upa</tt> - <tt>.upb</tt> - <tt>.url</tt> - <tt>.vrb</tt> - <tt>.w18</tt> - <tt>.xdv</tt> - <tt>.xref</tt> - <tt>.4ct</tt> - <tt>.4tc</tt>). - <!-- This is indeed a user-supplied config file: - <tt>.ist</tt> - --> - <br/> - And there are surely more that we have not yet encountered. - Please leave them all out of your upload! - <br/> - <a id="howtoavoidrubbish"></a> - Note for <tt>git</tt> users wishing to keep exported - <tt>.zip</tt> files “git rubbish free”: - This can be achieved by creating, adding and committing - a <tt>.gitattributes</tt> file containing lines like - the following: - <pre> + <p> + This concerns operating system specific + data (like <tt>__MACOSX</tt> directories and + <tt>.DS_Store</tt> files), + <tt>.git</tt>, + <tt>.gitignore</tt>, + <tt>.hgignore</tt>, + <tt>.hgtags</tt>, + editor backup files + (<tt>.backup</tt>, + <tt>.bak</tt>, + <tt>.sav</tt>, + <tt>.~</tt>, + …), + as well as “leftovers” + from TeX & friends and other programs + ( <tt>.aux</tt> + <tt>.log</tt> + <tt>.acn</tt> + <tt>.acr</tt> + <tt>.alg</tt> + <tt>.bbl</tt> + <tt>.bcf</tt> + <tt>.blg</tt> + <tt>.brf</tt> + <tt>.cb2</tt> + <tt>.cb</tt> + <tt>.cpt</tt> + <tt>.dvi</tt> + <tt>.ent</tt> + <tt>.fdb_latexmk</tt> + <tt>.fff</tt> + <tt>.fls</tt> + <tt>.fmt</tt> + <tt>.fot</tt> + <tt>.gaux</tt> + <tt>.glg</tt> + <tt>.glo</tt> + <tt>.glog</tt> + <tt>.gls</tt> + <tt>.glsdefs</tt> + <tt>.gtex</tt> + <tt>.hd</tt> + <tt>.idv</tt> + <tt>.idx</tt> + <tt>.ilg</tt> + <tt>.ind</tt> + <tt>.lg</tt> + <tt>.loa</tt> + <tt>.lod</tt> + <tt>.lof</tt> + <tt>.lol</tt> + <tt>.los</tt> + <tt>.lot</tt> + <tt>.lox</tt> + <tt>.maf</tt> + <tt>.mlf</tt> + <tt>.mlt</tt> + <tt>.mtc</tt> + <tt>.nav</tt> + <tt>.nlg</tt> + <tt>.nlo</tt> + <tt>.nls</tt> + <tt>.o</tt> + <tt>.obj</tt> + <tt>.out</tt> + <tt>.pdfsync</tt> + <tt>.pre</tt> + <tt>.pyg</tt> + <tt>.run.xml</tt> + <tt>.snm</tt> + <tt>.soc</tt> + <tt>.spl</tt> + <tt>.sta</tt> + <tt>.swp</tt> + <tt>.synctex</tt> + <tt>.synctex.gz</tt> + <tt>.tdo</tt> + <tt>.thm</tt> + <tt>.tmb</tt> + <tt>.tmp</tt> + <tt>.toc</tt> + <tt>.tpt</tt> + <tt>.trc</tt> + <tt>.ttt</tt> + <tt>.tuc</tt> + <tt>.upa</tt> + <tt>.upb</tt> + <tt>.url</tt> + <tt>.vrb</tt> + <tt>.w18</tt> + <tt>.xdv</tt> + <tt>.xref</tt> + <tt>.4ct</tt> + <tt>.4tc</tt> ). + <!-- This is indeed a user-supplied config file: + <tt>.ist</tt> + --> + </p> + <p> + And there are surely more that we have not yet encountered. + Please leave them all out of your upload! + </p> + <p> + <a id="howtoavoidrubbish"></a> + Note for <tt>git</tt> users wishing to keep exported + <tt>.zip</tt> files “git rubbish free”: + This can be achieved by creating, adding and committing + a <tt>.gitattributes</tt> file containing lines like + the following: + </p> + <pre> .gitignore export-ignore .gitattributes export-ignore - </pre> - Hints for Mac OSX users: - (a) The zip program from - <a href="https://www.yellowmug.com/yemuzip/"> - YemuZip</a> and the standard command line <tt>zip</tt> - program both permit to create MacOSX-rubbish-free - zipfiles. (Mind that for - <a href="https://www.yellowmug.com/yemuzip/"> - YemuZip</a> you have to choose the appropriate option!) - (b) A user told us that “it is possible to tell - Mac OSX's <tt>tar</tt> command line executable - to avoid polluting the archive with OSX specific - files, by setting the environment variable - <tt>COPYFILE_DISABLE</tt> (to whatever value).” - <!-- Didier Verna, Tue, 07 Mar 2017 13:48:01 +0100 --> + </pre> + <p> + Hints for Mac OSX users: + (a) The zip program from + <a href="https://www.yellowmug.com/yemuzip/"> + YemuZip</a> and the standard command line <tt>zip</tt> + program both permit to create MacOSX-rubbish-free + zipfiles. (Mind that for + <a href="https://www.yellowmug.com/yemuzip/"> + YemuZip</a> you have to choose the appropriate option!) + (b) A user told us that “it is possible to tell + Mac OSX's <tt>tar</tt> command line executable + to avoid polluting the archive with OSX specific + files, by setting the environment variable + <tt>COPYFILE_DISABLE</tt> (to whatever value).” + <!-- Didier Verna, Tue, 07 Mar 2017 13:48:01 +0100 --> + </p> </li> <li class="abstandoben"> @@ -911,25 +936,27 @@ No empty files or directories: </strong> </a> - <br /> - We tend to consider empty files and - directories as “rubbish”. - If you feel otherwise and wish to conserve - such files for systematic reasons, - we recommend filling them with some - comment (in the case of “regular files”) - or a placeholder file (in the case of directories) - explaining their purpose. - <br /> - If this is not possible - because the program using these files would get - disturbed by comments or “dummy files”, - please mention this in the - “Administrative notes” field - of the - <a href="https://ctan.org/upload">upload form</a> - so that we can make a note of this exception - and do not bother you with unnecessary complaints. + <p> + We tend to consider empty files and + directories as “rubbish”. + If you feel otherwise and wish to conserve + such files for systematic reasons, + we recommend filling them with some + comment (in the case of “regular files”) + or a placeholder file (in the case of directories) + explaining their purpose. + </p> + <p> + If this is not possible + because the program using these files would get + disturbed by comments or “dummy files”, + please mention this in the + “Administrative notes” field + of the + <a href="https://ctan.org/upload">upload form</a> + so that we can make a note of this exception + and do not bother you with unnecessary complaints. + </p> </li> <li class="abstandoben"> @@ -965,134 +992,145 @@ Line terminators of text files: </strong> </a> - <br /> - This paragraph is about - <a id="textfiles"> - “<span class="highlight">text files</span>” - </a> - (like - <tt>.txt</tt>, - <tt>.tex</tt>, - <tt>.sty</tt>, - <tt>.cls</tt>, - <tt>.dtx</tt>, - <tt>.fd</tt>, - <tt>.bib</tt>, - <tt>.c</tt>, - or any other file that can be edited - with a text editor) - as opposed to - “<span class="highlight">binary files</span>” - (such as - <tt>.gif</tt>, - <tt>.jpg</tt>, - <tt>.wav</tt>, - <tt>.mp3</tt>, - <tt>.ogg</tt>, - <tt>.tfm</tt>, - <tt>.pdf</tt>, - <tt>.doc</tt>, - <tt>.xls</tt>, - <tt>.exe</tt>, - and a multitude of others). - <br /> - The problem with such text files is - that different operating systems have different ways - of marking the - <span class="highlight">line endings</span> - within them: - Whereas Microsoft systems describe a line ending - in the good old typewriter fashion - by a “carriage return” character - followed by a “line feed” character, - UNIX type operating systems have always omitted - the “carriage return”, - and modern Mac OS X systems do it the same way. - <br /> - As CTAN's servers are running on - UNIX-like operating systems, - the CTAN team have decided - that all text files on the archive - should have suitable “linefeed only” - line terminators. - <br /> - Now, if you are a Windows user, - you need not be alarmed, - as there is an easy way to comply with this wish, - with hardly any inconvenience for yourself: - If you pack your upload file with a - <a id="goodzipprogram"> - <span class="highlight">“good zip program”</span>, - </a> - this will mark all text files with a special - “flag” (or “tag”) - that will permit CTAN's <tt>unzip</tt> program - to recognize these text files and perform the - necessary conversions - (in this case: omitting the unwanted - “carriage return” characters) - <em>automatically</em> <tt>:-)</tt> - <br /> - <a id="badzipprograms"></a> - Unfortunately, not all zip programs are - “good zip programs” <tt>:-(</tt> - <br /> - In particular, - <span class="highlight">7zip</span>, - the GNOME archive manager, - the <tt>Compress</tt> facility - accessible via the <tt>File</tt> menu - in Mac OS X's <tt>Finder</tt>, - and the feature that permits - to export zip files directly from - <span class="highlight">git</span> - repositories - do not seem to have the desired property. - (Please correct us if there has been recently - some positive development we are not aware of - by writing us an <a href="#ctanemail">email</a>!) - <br /> - <a id="gitandcrlf"></a> - However, - <span class="highlight">git</span> - users may want to have a look at the - <tt>.gitattributes</tt> file - for the configuration of file types - and line endings! - <br /> - <span class="highlight"> - Known - <a id="goodzipprogramnames"> - “good zip programs” - </a> - </span> - are - the Windows7ff. builtins, - WinZip, - Windows “Total Commander”, - and the zippers from - <a href="http://www.info-zip.org/"> - info-zip.org</a>. - <br /> - Mac users in need of a “good zip program” - may either turn to - <a href="https://www.yellowmug.com/yemuzip/"> - YemuZip</a> - or the standard <tt>zip</tt> command on their - command line - (which is in fact the info-zip tool that is - also present in Linux systems). - The command line <tt>zipinfo</tt> utility - is extremely useful for checking - zip archives once they have been created. - <br /> - <a id="tarnotxtvsbintags"></a> - Unfortunately, <b><tt>tar</tt></b> does <em>not</em> - offer the “tagging” feature in question. - <br /> - Finally, there are two - <span class="highlight">exceptions</span> - to what has been said before: + <p> + This paragraph is about + <a id="textfiles"> + “<span class="highlight">text files</span>” + </a> + (like + <tt>.txt</tt>, + <tt>.tex</tt>, + <tt>.sty</tt>, + <tt>.cls</tt>, + <tt>.dtx</tt>, + <tt>.fd</tt>, + <tt>.bib</tt>, + <tt>.c</tt>, + or any other file that can be edited + with a text editor) + as opposed to + “<span class="highlight">binary files</span>” + (such as + <tt>.gif</tt>, + <tt>.jpg</tt>, + <tt>.wav</tt>, + <tt>.mp3</tt>, + <tt>.ogg</tt>, + <tt>.tfm</tt>, + <tt>.pdf</tt>, + <tt>.doc</tt>, + <tt>.xls</tt>, + <tt>.exe</tt>, + and a multitude of others). + </p> + <p> + The problem with such text files is + that different operating systems have different ways + of marking the + <span class="highlight">line endings</span> + within them: + Whereas Microsoft systems describe a line ending + in the good old typewriter fashion + by a “carriage return” character + followed by a “line feed” character, + UNIX type operating systems have always omitted + the “carriage return”, + and modern Mac OS X systems do it the same way. + </p> + <p> + As CTAN's servers are running on + UNIX-like operating systems, + the CTAN team have decided + that all text files on the archive + should have suitable “linefeed only” + line terminators. + </p> + <p> + Now, if you are a Windows user, + you need not be alarmed, + as there is an easy way to comply with this wish, + with hardly any inconvenience for yourself: + If you pack your upload file with a + <a id="goodzipprogram"> + <span class="highlight">“good zip program”</span>, + </a> + this will mark all text files with a special + “flag” (or “tag”) + that will permit CTAN's <tt>unzip</tt> program + to recognize these text files and perform the + necessary conversions + (in this case: omitting the unwanted + “carriage return” characters) + <em>automatically</em> <tt>:-)</tt> + </p> + <p> + <a id="badzipprograms"></a> + Unfortunately, not all zip programs are + “good zip programs” <tt>:-(</tt> + </p> + <p> + In particular, + <span class="highlight">7zip</span>, + the GNOME archive manager, + the <tt>Compress</tt> facility + accessible via the <tt>File</tt> menu + in Mac OS X's <tt>Finder</tt>, + and the feature that permits + to export zip files directly from + <span class="highlight">git</span> + repositories + do not seem to have the desired property. + (Please correct us if there has been recently + some positive development we are not aware of + by writing us an <a href="#ctanemail">email</a>!) + </p> + <p> + <a id="gitandcrlf"></a> + However, + <span class="highlight">git</span> + users may want to have a look at the + <tt>.gitattributes</tt> file + for the configuration of file types + and line endings! + </p> + <p> + <span class="highlight"> + Known + <a id="goodzipprogramnames"> + “good zip programs” + </a> + </span> + are + the Windows7ff. builtins, + WinZip, + Windows “Total Commander”, + and the zippers from + <a href="http://www.info-zip.org/"> + info-zip.org</a>. + </p> + <p> + Mac users in need of a “good zip program” + may either turn to + <a href="https://www.yellowmug.com/yemuzip/"> + YemuZip</a> + or the standard <tt>zip</tt> command on their + command line + (which is in fact the info-zip tool that is + also present in Linux systems). + The command line <tt>zipinfo</tt> utility + is extremely useful for checking + zip archives once they have been created. + </p> + <p> + <a id="tarnotxtvsbintags"></a> + Unfortunately, <b><tt>tar</tt></b> does <em>not</em> + offer the “tagging” feature in question. + </p> + <p> + Finally, there are two + <span class="highlight">exceptions</span> + to what has been said before: + </p> <ol style="list-style-type:lower-alpha;"> <li class="kleinerabstandoben"> <em>If</em> your upload contains any @@ -1136,15 +1174,16 @@ “Canonical” URLs in documentation: </strong> </a> - <br /> - Please make sure when writing (or revising) - your documentation - that TeX software on CTAN archives - is referred to using our - <a href="#urls">preferred “canonical” URLs</a> - described - <a href="#urls">above</a> - rather that URLs pointing to individual CTAN servers. + <p> + Please make sure when writing (or revising) + your documentation + that TeX software on CTAN archives + is referred to using our + <a href="#urls">preferred “canonical” URLs</a> + described + <a href="#urls">above</a> + rather that URLs pointing to individual CTAN servers. + </p> </li> <li class="abstandoben"> @@ -1521,17 +1560,20 @@ In our webmaster's own words: </p> <blockquote> - Once you are logged into the CTAN site and visit the page - <a href="https://ctan.org/user/settings">https://ctan.org/user/settings</a> - (link in the upper right corner), you will find the section - “CTAN Contributor Confirmation” where you can - confirm the relation between the author id and the - current account by setting the check-mark. - In the same way you can remove the relation by unchecking. - <br/> - This feature is offered when one of the known email addresses - in the author database matches the email address of the account - (which can be edited on the same page). + <p> + Once you are logged into the CTAN site and visit the page + <a href="https://ctan.org/user/settings">https://ctan.org/user/settings</a> + (link in the upper right corner), you will find the section + “CTAN Contributor Confirmation” where you can + confirm the relation between the author id and the + current account by setting the check-mark. + In the same way you can remove the relation by unchecking. + </p> + <p> + This feature is offered when one of the known email addresses + in the author database matches the email address of the account + (which can be edited on the same page). + </p> </blockquote> @@ -1543,6 +1585,6 @@ $LastChangedDate$ </p> Until then: --> - Last updated: 2021-09-25 + Last updated: 2021-09-26 </body> </html> |