Browse Source

Upload rules, HTML, tedious

pjc 5 years ago
parent
commit
48a518fc18
1 changed files with 73 additions and 40 deletions
  1. 73
    40
      sections/rules/upload.php

+ 73
- 40
sections/rules/upload.php View File

49
         <p>
49
         <p>
50
           Please read this entire page carefully because it explains how the tracker organizes the content.
50
           Please read this entire page carefully because it explains how the tracker organizes the content.
51
           Referring to this page often will help you search faster and upload smarter.
51
           Referring to this page often will help you search faster and upload smarter.
52
-          I'll also go line-by-line through <a href="upload.php">the upload form</a>.
52
+          I'll also go line-by-line through the <a href="upload.php">upload form</a>.
53
         </p>
53
         </p>
54
 
54
 
55
         <p>
55
         <p>
161
 
161
 
162
         <li id="r1.9"><a href="#h1"><strong>&uarr;</strong></a> <a href="#r1.9">1.9</a>
162
         <li id="r1.9"><a href="#h1"><strong>&uarr;</strong></a> <a href="#r1.9">1.9</a>
163
           <strong>Compression.</strong>
163
           <strong>Compression.</strong>
164
-          "10 GiB or 10,000 files."
164
+          "10 GB or 10,000 files."
165
           Compression is required if your torrent is > 10 GiB or if it contains > 10,000 files.
165
           Compression is required if your torrent is > 10 GiB or if it contains > 10,000 files.
166
           Otherwise, please compress text files only if it reduces the torrent size by > 30% and avoid compressing binary files.
166
           Otherwise, please compress text files only if it reduces the torrent size by > 30% and avoid compressing binary files.
167
           Multipart archives are only allowed for torrents > 10 GiB.
167
           Multipart archives are only allowed for torrents > 10 GiB.
198
           please upload a quality conversion with supplemetal info.
198
           please upload a quality conversion with supplemetal info.
199
           Remember that small, one-shot metadata are better included with the data, and collections of docs and utils
199
           Remember that small, one-shot metadata are better included with the data, and collections of docs and utils
200
           are better separate from it.
200
           are better separate from it.
201
-          If only the header is different and it follows the "10 GiB or 10,000 files" rule, uncompressed torrents trump
201
+          If only the header is different and it follows the "10 GB or 10,000 files" rule, uncompressed torrents trump
202
           compressed ones.
202
           compressed ones.
203
           It should be easy for others with the same data to change a line and check out the new torrent.
203
           It should be easy for others with the same data to change a line and check out the new torrent.
204
         </li>
204
         </li>
234
         <li id="r2.5"><a href="#h2"><strong>&uarr;</strong></a> <a href="#r2.5">2.5</a>
234
         <li id="r2.5"><a href="#h2"><strong>&uarr;</strong></a> <a href="#r2.5">2.5</a>
235
           <strong>Watermarks.</strong>
235
           <strong>Watermarks.</strong>
236
           Data without watermarks trumps watermarked data.
236
           Data without watermarks trumps watermarked data.
237
+          </li>
238
+
239
+          <li id="r2.6"><a href="#h2"><strong>&uarr;</strong></a> <a href="#r2.6">2.6</a>
240
+          <strong>Stupid Compression.</strong>
241
+          If someone uploads, e.g., a gzip of 1000 images, you can trump the torrent with an uncompressed version.
242
+          Likewise, a compressed torrent with folders of 10,000 reads each is trumpable by one where the file structure is visible, even if the data itself is compressed.
243
+          </li>
237
       </ul>
244
       </ul>
238
     </div>
245
     </div>
239
 
246
 
246
           Please don't share <code>.torrent</code> files because they have your passkey embedded in them.
253
           Please don't share <code>.torrent</code> files because they have your passkey embedded in them.
247
           This passkey lets the tracker know who's uploading and downloading, and leaking it will nuke your ratio.
254
           This passkey lets the tracker know who's uploading and downloading, and leaking it will nuke your ratio.
248
           It's okay to share the files themselves any way you see fit.
255
           It's okay to share the files themselves any way you see fit.
249
-          Automatic mirroring to OpenBitTorrent is in development.
256
+          <?= SITE_NAME ?> maintains a 2nd tier public swarm for tracker redundancy.
250
           <br /><br />
257
           <br /><br />
251
         </li>
258
         </li>
252
 
259
 
253
         <li id="r3.2"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.2">3.2</a>
260
         <li id="r3.2"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.2">3.2</a>
254
-          <strong>Type.</strong>
261
+          <strong>Category.</strong>
255
           The categories loosely follow the central dogma.
262
           The categories loosely follow the central dogma.
256
-          It depends on what alphabet the sequence uses, e.g., ACGT vs. ACGU.
263
+          It depends on what alphabet the sequence uses, e.g., ACGT vs. ACGU vs. amino acids.
257
           All medical imaging data goes in the Imaging category.
264
           All medical imaging data goes in the Imaging category.
258
-          <!-- All extra documentation, custom scripts, etc., goes in Documents. -->
259
-          Toolkits and other things that aren't strictly biology data go in Extras.
265
+          Toolkits, documentation, disk images, and other things that aren't strictly biology data go in Extras.
260
           <br /><br />
266
           <br /><br />
261
         </li>
267
         </li>
262
 
268
 
265
           Please add accession numbers if they come with the data or if you acquired them for your own data.
271
           Please add accession numbers if they come with the data or if you acquired them for your own data.
266
           The number can be any format but it must correspond to the actual nucleotide or amino acid sequences represented on disk.
272
           The number can be any format but it must correspond to the actual nucleotide or amino acid sequences represented on disk.
267
           Don't add accession numbers just because the metadata matches.
273
           Don't add accession numbers just because the metadata matches.
268
-          RefSeq and UniProt integration is in development.
274
+          RefSeq and UniProt integration, including autofill, is in development.
269
           <br /><br />
275
           <br /><br />
270
         </li>
276
         </li>
271
 
277
 
272
         <li id="r3.4"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.4">3.4</a>
278
         <li id="r3.4"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.4">3.4</a>
279
+          <strong>Version.</strong>
280
+          Similar to the accession number field, version information should only exist if the original data is versioned or if you versioned your own data (recommended).
281
+          Any scheme is acceptable but Semantic Versioning is trongly encouraged.
282
+          <br /><br />
283
+        </li>
284
+
285
+        <li id="r3.5"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.5">3.5</a>
273
           <strong>Torrent Title.</strong>
286
           <strong>Torrent Title.</strong>
274
           A short description of the torrent contents such as a FASTA definition line.
287
           A short description of the torrent contents such as a FASTA definition line.
275
           It doesn't need to match the folders but it should tell you what the data is at a glance.
288
           It doesn't need to match the folders but it should tell you what the data is at a glance.
277
           <br /><br />
290
           <br /><br />
278
         </li>
291
         </li>
279
 
292
 
280
-        <li id="r3.5"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.5">3.5</a>
293
+        <li id="r3.6"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.6">3.6</a>
281
           <strong>Organism.</strong>
294
           <strong>Organism.</strong>
282
           The relevant organism's binomial name and optional subspecies.
295
           The relevant organism's binomial name and optional subspecies.
283
           Please use <em>Genus species subspecies</em> and not terms such as var. and subsp.
296
           Please use <em>Genus species subspecies</em> and not terms such as var. and subsp.
285
           <br /><br />
298
           <br /><br />
286
         </li>
299
         </li>
287
 
300
 
288
-        <li id="r3.6"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.6">3.6</a>
301
+        <li id="r3.7"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.7">3.7</a>
289
           <strong>Strain/Variety.</strong>
302
           <strong>Strain/Variety.</strong>
290
           The strain's name if known.
303
           The strain's name if known.
291
           This should correspond to a specific cell line, cultivar, or breed.
304
           This should correspond to a specific cell line, cultivar, or breed.
295
           <br /><br />
308
           <br /><br />
296
         </li>
309
         </li>
297
 
310
 
298
-        <li id="r3.7"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.7">3.7</a>
311
+        <li id="r3.8"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.8">3.8</a>
299
           <strong>Authors(s).</strong>
312
           <strong>Authors(s).</strong>
300
           The Author field should contain only the author name and no titles.
313
           The Author field should contain only the author name and no titles.
301
           The upload form supports multiple authors.
314
           The upload form supports multiple authors.
305
           <br /><br />
318
           <br /><br />
306
         </li>
319
         </li>
307
 
320
 
308
-        <li id="r3.8"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.8">3.8</a>
321
+        <li id="r3.9"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.9">3.9</a>
309
           <strong>Department/Lab.</strong>
322
           <strong>Department/Lab.</strong>
310
           The lab that did the experiments or the last author's home lab.
323
           The lab that did the experiments or the last author's home lab.
311
           Please use "Unaffiliated" for anonymous or unknown labs.
324
           Please use "Unaffiliated" for anonymous or unknown labs.
312
           <br /><br />
325
           <br /><br />
313
         </li>
326
         </li>
314
 
327
 
315
-        <li id="r3.9"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.9">3.9</a>
328
+        <li id="r3.10"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.10">3.10</a>
316
           <strong>Location.</strong>
329
           <strong>Location.</strong>
317
           The lab's physical location in one of the below formats.
330
           The lab's physical location in one of the below formats.
318
           <ul>
331
           <ul>
325
           <br /><br />
338
           <br /><br />
326
         </li>
339
         </li>
327
 
340
 
328
-        <li id="r3.10"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.10">3.10</a>
341
+        <li id="r3.11"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.11">3.11</a>
329
           <strong>Year.</strong>
342
           <strong>Year.</strong>
330
           The year the data was first published.
343
           The year the data was first published.
331
           The publication that announced the data.
344
           The publication that announced the data.
332
           <br /><br />
345
           <br /><br />
333
         </li>
346
         </li>
334
 
347
 
335
-        <li id="r3.11"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.11">3.11</a>
348
+        <li id="r3.12"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.12">3.12</a>
349
+          <strong>License.</strong>
350
+          <?= SITE_NAME ?> only allows permissive licenses.
351
+          If your data is original, please consider licensing it under one of the available options.
352
+          The "Unspecified" option is for compatibility with existing releases.
353
+          <br /><br />
354
+        </li>
355
+
356
+        <li id="r3.13"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.13">3.13</a>
336
           <strong>Platform.</strong>
357
           <strong>Platform.</strong>
337
           The class of technology the data comes from.
358
           The class of technology the data comes from.
338
           What sequencing or imaging technique is it the output of?
359
           What sequencing or imaging technique is it the output of?
340
             href="forums.php?action=viewforum&forumid=<?= SUGGESTIONS_FORUM_ID ?>">Please
361
             href="forums.php?action=viewforum&forumid=<?= SUGGESTIONS_FORUM_ID ?>">Please
341
             post in the suggestions forum</a>
362
             post in the suggestions forum</a>
342
           if you'd like to request a new platform.
363
           if you'd like to request a new platform.
343
-          Note that the platforms change for the Imaging category.
364
+          Note that the platforms change for each category.
344
           <br /><br />
365
           <br /><br />
345
         </li>
366
         </li>
346
 
367
 
347
-        <li id="r3.12"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.12">3.12</a>
368
+        <li id="r3.14"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.14">3.14</a>
348
           <strong>Format.</strong>
369
           <strong>Format.</strong>
349
           The file format of the data.
370
           The file format of the data.
350
           What programs do you need to work with the data?
371
           What programs do you need to work with the data?
352
             href="forums.php?action=viewforum&forumid=<?= SUGGESTIONS_FORUM_ID ?>">Please
373
             href="forums.php?action=viewforum&forumid=<?= SUGGESTIONS_FORUM_ID ?>">Please
353
             post in the suggestions forum</a>
374
             post in the suggestions forum</a>
354
           if you'd like to request a new format.
375
           if you'd like to request a new format.
355
-          Note that the formats change for the Protein and Imaging categories.
356
-          A file extension parser is in development.
376
+          Note that the formats change for each category.
377
+          You can elect to have the site detect the data format by its file extension.
357
           <br /><br />
378
           <br /><br />
358
         </li>
379
         </li>
359
 
380
 
360
-        <li id="r3.13"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.13">3.13</a>
381
+        <li id="r3.15"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.15">3.15</a>
382
+          <strong>Archive.</strong>
383
+          The compression algorithm used, if any.
384
+          You can elect to have the site detect the archive format by its file extension.
385
+          <br /><br />
386
+        </li>
387
+
388
+        <li id="r3.16"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.16">3.16</a>
361
           <strong>Assembly Level.</strong>
389
           <strong>Assembly Level.</strong>
362
           The resolution of the data.
390
           The resolution of the data.
363
           How much information about the organism does it represent?
391
           How much information about the organism does it represent?
368
           <br /><br />
396
           <br /><br />
369
         </li>
397
         </li>
370
 
398
 
371
-        <li id="r3.14"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.14">3.14</a>
372
-          <strong>License.</strong>
373
-          <?= SITE_NAME ?> only allows permissive licenses.
374
-          If your data is original, please consider licensing it under one of the available options.
375
-          The "Unspecified" option is for compatibility with existing releases.
376
-          <br /><br />
377
-        </li>
378
-
379
-        <li id="r3.15"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.15">3.15</a>
399
+        <li id="r3.17"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.17">3.17</a>
380
           <strong>Tags.</strong>
400
           <strong>Tags.</strong>
381
           Please select at least five appropriate tags.
401
           Please select at least five appropriate tags.
382
           Don't use irrelevant tags, and consider making new tags as a last resort.
402
           Don't use irrelevant tags, and consider making new tags as a last resort.
387
           <br /><br />
407
           <br /><br />
388
         </li>
408
         </li>
389
 
409
 
390
-        <li id="r3.16"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.16">3.16</a>
410
+        <li id="r3.18"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.18">3.18</a>
391
           <strong>Picture.</strong>
411
           <strong>Picture.</strong>
392
           Please upload a meaningful picture, especially if you plan to add the torrent to a collection.
412
           Please upload a meaningful picture, especially if you plan to add the torrent to a collection.
393
           A photo of the sequence sample or a representative photo of the organism; an example (preferably not a
413
           A photo of the sequence sample or a representative photo of the organism; an example (preferably not a
396
           <br /><br />
416
           <br /><br />
397
         </li>
417
         </li>
398
 
418
 
399
-        <li id="r3.17"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.17">3.17</a>
419
+        <li id="r3.19"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.19">3.19</a>
420
+          <strong>Mirrors.</strong>
421
+          <?= SITE_NAME ?> supports up to two FTP/HTTP web seeds on an experimental basis according to
422
+          <a href="https://www.bittorrent.org/beps/bep_0019.html" target="_blank">BEP 19 (GetRight style)</a>.
423
+          Please note that not all clients support web seeds, and of those that do, having too many may cause problems for you.
424
+          The web seeds must be unencrypted.
425
+          The site will automatically rewrite <code>ftps://</code> and <code>https://</code> web addresses.
426
+          Additionally, the contents of the FTP/HTTP folder must correspond exactly to the contents of the <code>.torrent</code> file.
427
+          Given these caveats, it's worth documenting the data source for accuracy's sake and to let people save ratio here.
428
+
429
+          <br /><br />
430
+        </li>
431
+
432
+        <li id="r3.20"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.20">3.20</a>
400
           <strong>Publications.</strong>
433
           <strong>Publications.</strong>
401
           DOI numbers should be well-formed, one per line.
434
           DOI numbers should be well-formed, one per line.
402
-          The system currently discards malformed DOI numbers instead of extracting them from arbitrary strings.
403
-          An auto-extract feature is in development.
404
-          If your research is a URI, please use the Torrent Group Description field for now.
435
+          The site currently discards malformed DOI numbers instead of extracting them from arbitrary strings.
436
+          An auto-extract and metadata fetching are in development.
437
+          If your research is a normal URI, please use the Torrent Group Description field.
405
           <br /><br />
438
           <br /><br />
406
         </li>
439
         </li>
407
 
440
 
408
-        <li id="r3.18"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.18">3.18</a>
441
+        <li id="r3.21"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.21">3.21</a>
409
           <strong>Torrent Group Description.</strong>
442
           <strong>Torrent Group Description.</strong>
410
           General info about the object of study's function or significance.
443
           General info about the object of study's function or significance.
411
           This is the main body text on a torrent's page.
444
           This is the main body text on a torrent's page.
413
           <br /><br />
446
           <br /><br />
414
         </li>
447
         </li>
415
 
448
 
416
-        <li id="r3.19"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.19">3.19</a>
449
+        <li id="r3.22"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.22">3.22</a>
417
           <strong>Torrent Description.</strong>
450
           <strong>Torrent Description.</strong>
418
           Specific info about the protocols and equipment relevant to <em>this</em> data.
451
           Specific info about the protocols and equipment relevant to <em>this</em> data.
419
           This text is hidden by default.
452
           This text is hidden by default.
422
           <br /><br />
455
           <br /><br />
423
         </li>
456
         </li>
424
 
457
 
425
-        <li id="r3.20"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.20">3.20</a>
426
-          <strong>Aligned Sequence.</strong>
458
+        <li id="r3.23"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.23">3.23</a>
459
+          <strong>Aligned/Annotated.</strong>
427
           Does the data come with any metadata of an analytical nature, such as alignment data (mandatory if checked)?
460
           Does the data come with any metadata of an analytical nature, such as alignment data (mandatory if checked)?
428
           If so, does the torrent folder contain the scripts used to generate the metadata (optional)?
461
           If so, does the torrent folder contain the scripts used to generate the metadata (optional)?
429
           <br /><br />
462
           <br /><br />
430
         </li>
463
         </li>
431
 
464
 
432
-        <li id="r3.21"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.21">3.21</a>
465
+        <li id="r3.24"><a href="#h3"><strong>&uarr;</strong></a> <a href="#r3.24">3.24</a>
433
           <strong>Upload Anonymously.</strong>
466
           <strong>Upload Anonymously.</strong>
434
           You'll still get upload credit even if you hide your username from the torrent details.
467
           You'll still get upload credit even if you hide your username from the torrent details.
435
           I believe it's still visible to sysops.
468
           I believe it's still visible to sysops.

Loading…
Cancel
Save