docs(CONTRIBUTING): complete creators guidelines with relator terms (#7102)
* complete creators guidelines with relator terms * Update CONTRIBUTING.md minor language editing * Update CONTRIBUTING.md recover missing MARC relators URL to complete empty link * chore: copy ENG missing texts to translated files * chore: translate new texts to spanish * chore: translate new text to italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Eric Hellman <eric@hellman.net> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>pull/7144/head
David Ordás
GitHub
parent
d3caf7415f
commit
e091eeedf0
|
|
@ -56,6 +56,7 @@ Durch Deine Mitwirkung verpflichtest Du Dich, dem [Verhaltenskodex](CODE_OF_COND
|
|||
- Vermerke das Datum der Veröffentlichung im Titel, wenn es sich um ein älteres Buch handelt.
|
||||
- Erfasse gegebenenfalls den Namen des oder der Autoren. Eine längere Liste von Autoren kann mit dem Zusatz "`et al.`" gekürzt werden.
|
||||
- Wenn das Buch noch nicht fertiggestellt ist und sich noch in Bearbeitung befindet, füge wie [unten](#in_process) beschrieben einen "`in process`" Hinweis hinzu.
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- Wenn eine funktionierende E-Mail Adresse oder das Einrichten eines Benutzerkontos vor Aktivierung des Downloads erbeten wird, sollten angemessene Hinweise in Klammern angegeben werden, z. B.: `(E-Mail Adresse *erbeten*, nicht erforderlich)`.
|
||||
|
||||
|
||||
|
|
@ -134,6 +135,12 @@ Beispiel:
|
|||
RICHTIG: * [Wird bald ein tolles Buch sein](http://example.com/book2.html) - John Doe (HTML) (:construction: *in Bearbeitung*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
RICHTIG: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetische Sortierung
|
||||
|
||||
- Wenn mehrere Titel mit demselben Buchstaben beginnen, sortiere sie nach dem zweiten Buchstaben und so weiter. Zum Beispiel folgt `ab` nach `aa`.
|
||||
|
|
@ -171,9 +178,17 @@ Unsere Listen enthalten einen minimalen Satz an Metadaten: Titel, URLs, Autoren,
|
|||
##### Urheber
|
||||
|
||||
- Wir wollen alle Urheber kostenloser Inhalte angemessen nennen, inklusive eventueller Übersetzer!
|
||||
- For übersetzte Werke sollte der Autor des ursprünglichen Werks genannt werden.
|
||||
- For übersetzte Werke sollte der Autor des ursprünglichen Werks genannt werden. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-de.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Wir erlauben keine Links für Urheber.
|
||||
- Für Sammlungen oder neu zusammengestellte Werke, benötigt der "Urheber" eventuell eine Beschreibung. Bücher von "GoalKicker" werden z. B. als "`Zusammengestellt aus StackOverflow Dokumentationen`" (auf englisch: "`Compiled from StackOverflow documentation`") gekennzeichnet.
|
||||
- Für Sammlungen oder neu zusammengestellte Werke, benötigt der "Urheber" eventuell eine Beschreibung. Bücher von "GoalKicker" oder "RIP Tutorial" werden z. B. als "`Zusammengestellt aus StackOverflow Dokumentationen`" (auf englisch: "`Compiled from StackOverflow documentation`") gekennzeichnet.
|
||||
|
||||
|
||||
##### Plattformen und Zugriffshinweise
|
||||
|
|
|
|||
|
|
@ -172,7 +172,7 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
- No emojis.
|
||||
|
||||
|
||||
#### URLs
|
||||
##### URLs
|
||||
|
||||
- Δεν επιτρέπουμε περικομμένα URLs.
|
||||
- Κωδικοί ανίχνευσης πρέπει να αφαιρεθούν από το URL.
|
||||
|
|
@ -181,15 +181,23 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
- Δεν μας αρέσουν URLs που οδηγούν σε ιστοσελίδες που δεν φιλοξενούν το υλικό που αναφέρεται, αλλά αντ' αυτού οδηγούν αλλού.
|
||||
|
||||
|
||||
#### Δημιουργοί
|
||||
##### Δημιουργοί
|
||||
|
||||
- Θέλουμε να αναφέρονται τα ονόματα των δημιουργών δωρεάν υλικού όπου κρίνεται κατάλληλο, συμπεριλαμβανομένων των μεταφραστών!
|
||||
- Για μεταφρασμένα έργα, θα πρέπει να αναφέρεται το όνομα του αρχικού συγγραφέα.
|
||||
- Για μεταφρασμένα έργα, θα πρέπει να αναφέρεται το όνομα του αρχικού συγγραφέα. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-el.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Δεν επιτρέπουμε συνδέσμους για Δημιουργούς.
|
||||
- Για συλλεγμένα ή επεξεργασμένα έργα, ο "δημιουργός" ίσως χρειάζεται περιγραφή. Για παράδειγμα, τα βιβλία από το "GoalKicker" ή "RIP Tutorial" αναφέρονται ως "`Συντάχθηκαν από documentation του StackOverflow`" (στα αγγλικά: "`Compiled from StackOverflow documentation`").
|
||||
|
||||
|
||||
#### Πλατφόρμες και Σημειώσεις Πρόσβασης
|
||||
##### Πλατφόρμες και Σημειώσεις Πρόσβασης
|
||||
|
||||
- Μαθήματα. Ειδικά για τις λίστες μαθημάτων μας, η πλατφόρμα είναι ένα σημαντικό κομμάτι της περιγραφής του υλικού. Αυτό επειδή οι πλατφόρμες με μαθήματα έχουν διαφορετική προσβασιμότητα και μοντέλα πρόσβασης. Ενώ συνήθως δεν θα προσθέσουμε ένα βιβλίο που απαιτεί εγγραφή, πολλές πλατφόρμες μαθημάτων έχουν χαρακτηριστικά που δεν θα δουλέψουν χωρίς κάποιο τύπο λογαριασμού. Παραδείγματα πλατφορμών μαθημάτων περιλαμβάνουν τα Coursera, EdX, Udacity και Udemy. Όταν ένα μάθημα εξαρτάται από την πλατφόρμα, το όνομα της πλατφόρμας θα πρέπει να αναφέρεται σε παρένθεση.
|
||||
- YouTube. Έχουμε πολλά μαθήματα που αποτελούνται από playlists στο YouTube. Δεν παραθέτουμε το YouTube σαν πλατφόρμα, προσπαθούμε να αναφέρουμε τον δημιουργό στο YouTube, που είναι συνήθως υπό-πλατφόρμα.
|
||||
|
|
@ -203,7 +211,7 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
Ο πρώτος κανόνας στην απόφαση για το σε ποια λίστα ανήκει το υλικό είναι να δείτε πώς περιγράφει τον εαυτό του. Αν αυτοαποκαλείται βιβλίο, τότε ίσως είναι βιβλίο.
|
||||
|
||||
|
||||
#### Είδη που δεν παραθέτουμε
|
||||
##### Είδη που δεν παραθέτουμε
|
||||
|
||||
Επειδή το Internet είναι μεγάλο, δεν περιέχουμε στις λίστες μας:
|
||||
|
||||
|
|
@ -220,7 +228,7 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
Οι λίστες μας ανταγωνιστικού προγραμματισμού δεν είναι το ίδιο αυστηρές με αυτούς τους αποκλεισμούς. Τα περιθώρια αυτού του αποθετηρίου αποφασίζονται από την κοινότητα· αν θέλετε να προτείνετε μια αλλαγή ή μια προσθήκη στον σκοπό, παρακαλούμε χρησιμοποιήστε ένα issue για να κάνετε μια πρόταση.
|
||||
|
||||
|
||||
#### Βιβλία vs. Άλλα Πράγματα
|
||||
##### Βιβλία vs. Άλλα Πράγματα
|
||||
|
||||
Δεν είμαστε τόσο γκρινιάρηδες για την βιβλιό-τητα. Ορίστε μερικά χαρακτηριστικά που εκφράζουν ότι το υλικό είναι βιβλίο:
|
||||
|
||||
|
|
@ -235,7 +243,7 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
Υπάρχουν πολλά βιβλία που παραθέτουμε που δεν έχουν αυτά τα χαρακτηριστικά· μπορεί να εξαρτάται από την περίπτωση.
|
||||
|
||||
|
||||
#### Βιβλία vs. Μαθήματα
|
||||
##### Βιβλία vs. Μαθήματα
|
||||
|
||||
Μερικές φορές μπορεί να είναι δύσκολο να τα ξεχωρίσουμε!
|
||||
|
||||
|
|
|
|||
|
|
@ -190,7 +190,15 @@ Nuestros listados proporcionan un conjunto mínimo de metadatos: títulos, URL,
|
|||
##### Atribuciones
|
||||
|
||||
- Queremos dar crédito a los creadores de recursos gratuitos cuando sea apropiado, ¡incluso traductores!
|
||||
- En el caso de obras traducidas, se debe acreditar también al autor original.
|
||||
- En el caso de obras traducidas, se debe acreditar también al autor original. Recomendamos usar [MARC relators](https://loc.gov/marc/relators/relaterm.html) para dar presencia al resto de creadores diferentes al autor original, tal y como se muestra en este ejemplo:
|
||||
|
||||
```markdown
|
||||
* [Un libro traducido](http://example.com/book-es.html) - John Doe, `trl.:` Mike Traduce
|
||||
```
|
||||
|
||||
donde, la anotación `trl.:` incluye el código MARC relator para "traductor".
|
||||
- Utilice comas `,` para separar cada elemento de la lista de autores.
|
||||
- Cuando sean muchas, puedes valerte de "`et al.`" para acortar dicha lista.
|
||||
- No permitimos enlaces directos al creador.
|
||||
- En el caso de recopilaciones u obras remezcladas, el "creador" puede necesitar una descripción. Por ejemplo, los libros de "GoalKicker" o "RIP Tutorial" se acreditan como "`Creado a partir de la documentación de StackOverflow`" (en inglés: "`Compiled from StackOverflow documentation`").
|
||||
|
||||
|
|
|
|||
|
|
@ -59,6 +59,7 @@
|
|||
* اگر کتاب قدیمی است، تاریخ انتشار را در کنار عنوان بنویسید.
|
||||
* نام نویسنده یا نویسندگان را در صورت امکان بنویسید. میتوانید فهرست نویسندگان را با "و همکاران" (به انگلیسی: "`et al.`") کوتاه کنید.
|
||||
* اگر کتاب هنوز تمام نشده است و هنوز روی آن کار میشود، عبارت "`in process`" را همان طور که در [پایین صفحه](#in_process) آمده به آن اضافه کنید.
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
* اگر پیش از دانلود، نشانی ایمیل یا ساخت حساب کاربری خواسته میشود، در پرانتز توضیح متناسبی بنویسید. مثلا: `(نشانی ایمیل *خواسته میشود* اما اجباری نیست)`.
|
||||
|
||||
|
||||
|
|
@ -138,6 +139,11 @@
|
|||
خوب: * [کتابی که عالی خواهدشد](http://example.com/book2.html) - نام نویسنده (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
خوب: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### ترتیب الفبایی
|
||||
|
||||
|
|
@ -147,6 +153,105 @@
|
|||
اگر لینکی را در جای نادرست دیدید، پیام خطای linter را ببینید تا بفهمید کدام خطها باید جابجا شوند.
|
||||
|
||||
|
||||
### Notes
|
||||
|
||||
While the basics are relatively simple, there is a great diversity in the resources we list. Here are some notes on how we deal with this diversity.
|
||||
|
||||
|
||||
#### Metadata
|
||||
|
||||
Our lists provide a minimal set of metadata: titles, URLs, creators, platforms, and access notes.
|
||||
|
||||
|
||||
##### Titles
|
||||
|
||||
- No invented titles. We try to take titles from the resources themselves; contributors are admonished not to invent titles or use them editorially if this can be avoided. An exception is for older works; if they are primarily of historical interest, a year in parentheses appended to the title helps users know if they are of interest.
|
||||
- No ALLCAPS titles. Usually title case is appropriate, but when doubt use the capitalization from the source
|
||||
- No emojis.
|
||||
|
||||
|
||||
##### URLs
|
||||
|
||||
- We don't permit shortened URLs.
|
||||
- Tracking codes must be removed from the URL.
|
||||
- International URLs should be escaped. Browser bars typically render these to Unicode, but use copy and paste, please.
|
||||
- Secure (`https`) URLs are always preferred over non-secure (`http`) urls where HTTPS has been implemented.
|
||||
- We don't like URLs that point to webpages that don't host the listed resource, but instead point elsewhere.
|
||||
|
||||
|
||||
##### Creators
|
||||
|
||||
- We want to credit the creators of free resources where appropriate, including translators!
|
||||
- For translated works the original author should be credited. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-fa_IR.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- We do not permit links for Creators.
|
||||
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "`Compiled from StackOverflow documentation`".
|
||||
|
||||
|
||||
##### Platforms and Access Notes
|
||||
|
||||
- Courses. Especially for our course lists, the platform is an important part of the resource description. This is because course platforms have different affordances and access models. While we usually won't list a book that requires a registration, many course platforms have affordances that don't work without some sort of account. Example course platforms include Coursera, EdX, Udacity, and Udemy. When a course depends on a platform, the platform name should be listed in parentheses.
|
||||
- YouTube. We have many courses which consist of YouTube playlists. We do not list YouTube as a platform, we try to list the YouTube creator, which is often a sub-platform.
|
||||
- YouTube videos. We usually don't link to individual YouTube videos unless they are more than an hour long and are structured like a course or a tutorial.
|
||||
- Leanpub. Leanpub hosts books with a variety of access models. Sometimes a book can be read without registration; sometimes a book requires a Leanpub account for free access. Given quality of the books and the mixture and fluidity of Leanpub access models, we permit listing of the latter with the access note `*(Leanpub account or valid email requested)*`.
|
||||
|
||||
|
||||
#### Genres
|
||||
|
||||
The first rule in deciding which list a resource belongs in is to see how the resource describes itself. If it calls itself a book, then maybe it's a book.
|
||||
|
||||
|
||||
##### Genres we don't list
|
||||
|
||||
Because the Internet is vast, we don't include in our lists:
|
||||
|
||||
- blogs
|
||||
- blog posts
|
||||
- articles
|
||||
- websites (except for those that host LOTS of items that we list).
|
||||
- videos that aren't courses or screencasts.
|
||||
- book chapters
|
||||
- teaser samples from books
|
||||
- IRC or Telegram channels
|
||||
- Slacks or mailing lists
|
||||
|
||||
Our competitive programming lists are not as strict about these exclusions. The scope of the repo is determined by the community; if you want to suggest a change or addition to the scope, please use an issue to make the suggestion.
|
||||
|
||||
|
||||
##### Books vs. Other Stuff
|
||||
|
||||
We're not that fussy about book-ness. Here are some attributes that signify that a resource is a book:
|
||||
|
||||
- it has an ISBN (International Standard Book Number)
|
||||
- it has a Table of Contents
|
||||
- a downloadable version is offered, especially ePub files.
|
||||
- it has editions
|
||||
- it doesn't depend on interactive content or videos
|
||||
- it tries to comprehensively cover a topic
|
||||
- it's self-contained
|
||||
|
||||
There are lots of books that we list that don't have these attributes; it can depend on context.
|
||||
|
||||
|
||||
##### Books vs. Courses
|
||||
|
||||
Sometimes these can be hard to distinguish!
|
||||
|
||||
Courses often have associated textbooks, which we would list in our books lists. Courses have lectures, exercises, tests, notes or other didactic aids. A single lecture or video by itself is not a course. A powerpoint is not a course.
|
||||
|
||||
|
||||
##### Interactive Tutorials vs. Other stuff
|
||||
|
||||
If you can print it out and retain its essence, it's not an Interactive Tutorial.
|
||||
|
||||
|
||||
### خودکارسازی
|
||||
|
||||
* قوانین فرمتبندی از طریق [GitHub Actions](https://docs.github.com/en/actions) با استفاده از [fpb-lint](https://github.com/vhf/free-programming-books-lint) بررسی میشوند ([`.github/workflows/fpb-lint.yml`](../.github/workflows/fpb-lint.yml) را ببینید)
|
||||
|
|
|
|||
|
|
@ -180,7 +180,15 @@ Nagbibigay ang aming mga listahan ng kaunting hanay ng metadata: mga pamagat, UR
|
|||
##### Mga tagalikha
|
||||
|
||||
- Gusto naming pasalamatan ang mga lumikha ng mga libreng mapagkukunan kung saan naaangkop, kabilang ang mga tagasalin!
|
||||
- Para sa mga isinaling gawa ang orihinal na may-akda ay dapat na kredito.
|
||||
- Para sa mga isinaling gawa ang orihinal na may-akda ay dapat na kredito. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-fil.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Hindi namin pinahihintulutan ang mga link para sa Mga Tagalikha.
|
||||
- Para sa compilation o remixed na mga gawa, maaaring kailanganin ng "creator" ang isang paglalarawan. Halimbawa, ang mga aklat na "GoalKicker" o "RIP Tutorial" ay kinikilala bilang "`Compiled from StackOverflow Documentation`".
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ En contribuant, vous acceptez de respecter le [Code de Contrat](CODE_OF_CONDUCT-
|
|||
- si le livre est plus ancien, indiquez la date de parution avec le titre.
|
||||
- incluez le ou les noms de l'auteur, le cas échéant. Vous pouvez raccourcir les listes d'auteurs avec "`et al.`".
|
||||
- si le livre n'est pas terminé, et est toujours en cours de travail, ajoutez la notation "`en cours`", comme décrit [ci-dessous](#in_process).
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- si une adresse e-mail ou la configuration d'un compte est demandée avant l'activation du téléchargement, ajoutez des notes adaptées à la langue entre parenthèses, par exemple: `(adresse e-mail *demandée*, non obligatoire)`.
|
||||
|
||||
|
||||
|
|
@ -134,9 +135,15 @@ Exemple:
|
|||
BIEN : * [Sera bientôt un livre génial](http://exemple.com/livre2.html) - John Doe (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
BIEN : * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### <a id="alphabetical-order"></a>Ordre alphabétique
|
||||
|
||||
- Lorsque plusieurs titres commencent par la même lettre, organisez-les par la seconde, et ainsi de suite. Par exemple: `aa` vient avant `ab`.
|
||||
- Lorsque plusieurs titres commencent par la même lettre, organisez-les par la seconde, et ainsi de suite. Par exemple: `aa` vient avant `ab`.
|
||||
|
||||
- `un deux` vient avant `undeux`
|
||||
|
||||
|
|
@ -172,9 +179,17 @@ Nos listes fournissent un ensemble minimal de métadonnées : titres, URL, créa
|
|||
##### Créateurs
|
||||
|
||||
- Nous voulons créditer les créateurs de ressources gratuites le cas échéant, y compris les traducteurs !
|
||||
- Pour les œuvres traduites, l'auteur original doit être crédité.
|
||||
- Pour les œuvres traduites, l'auteur original doit être crédité. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-fr.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Nous n'autorisons pas les liens pour les créateurs.
|
||||
- Pour les compilations ou les travaux remixés, le "créateur" peut avoir besoin d'une description. Par exemple, les livres "GoalKicker" sont crédités comme "`Compilé à partir de la documentation StackOverflow`" (en anglais: `Compiled from StackOverflow documentation`).
|
||||
- Pour les compilations ou les travaux remixés, le "créateur" peut avoir besoin d'une description. Par exemple, les livres "GoalKicker" ou "RIP Tutorial" sont crédités comme "`Compilé à partir de la documentation StackOverflow`" (en anglais: `Compiled from StackOverflow documentation`).
|
||||
|
||||
|
||||
##### Plateformes et notes d'accès
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@ Dengan partisipasi Anda, Anda berjanji untuk mengikuti [Kode Etik](CODE_OF_CONDU
|
|||
- jika buku lebih tua, sertakan tanggal penerbitan dengan judul.
|
||||
- sertakan nama penulis atau nama yang sesuai. Anda dapat mempersingkat daftar penulis dengan "`et al.`".
|
||||
- jika buku belum selesai, dan masih dalam pengerjaan, tambahkan notasi "`dalam proses`", seperti yang dijelaskan [di bawah ini](#in_process).
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- jika alamat email atau pengaturan akun diminta sebelum pengunduhan diaktifkan, tambahkan catatan bahasa yang sesuai dalam tanda kurung, misalnya: `(alamat email *diminta*, tidak wajib)`.
|
||||
|
||||
|
||||
|
|
@ -140,6 +141,12 @@ Contoh:
|
|||
BAIK : * [Akan Segera Menjadi Buku yang Luar Biasa](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
BAIK : * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -180,9 +187,17 @@ Daftar kami menyediakan kumpulan metadata minimal: judul, URL, pembuat, platform
|
|||
##### Pencipta
|
||||
|
||||
- Kami ingin menghargai pencipta sumber daya gratis jika perlu, termasuk penerjemah!
|
||||
- Untuk karya terjemahan penulis asli harus dikreditkan.
|
||||
- Untuk karya terjemahan penulis asli harus dikreditkan. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-id.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Kami tidak mengizinkan tautan untuk Kreator.
|
||||
- Untuk karya kompilasi atau remix, "pencipta" mungkin memerlukan deskripsi. Misalnya, buku "GoalKicker" dikreditkan sebagai "`Dikompilasi dari dokumentasi StackOverflow`" (dalam Bahasa Inggris: `Compiled from StackOverflow documentation`).
|
||||
- Untuk karya kompilasi atau remix, "pencipta" mungkin memerlukan deskripsi. Misalnya, buku "GoalKicker" atau "RIP Tutorial" dikreditkan sebagai "`Dikompilasi dari dokumentasi StackOverflow`" (dalam Bahasa Inggris: `Compiled from StackOverflow documentation`).
|
||||
|
||||
|
||||
<!----><a id="platforms-and-access-notes"></a>
|
||||
|
|
|
|||
|
|
@ -180,7 +180,15 @@ I nostri elenchi forniscono un set minimo di metadati: titoli, URLs, autori, pia
|
|||
##### Autori
|
||||
|
||||
- Vogliamo dare i crediti agli autori ove appropriato, anche ai traduttori!
|
||||
- Per i lavori tradotti, l'autore originale dovrebbe essere incluso.
|
||||
- Per i lavori tradotti, l'autore originale dovrebbe essere incluso. Consigliamo di usare [MARC relators](https://loc.gov/marc/relators/relaterm.html) per accreditare autori diversi dal creatore, per esempio:
|
||||
|
||||
```markdown
|
||||
* [Un libro tradotto](http://example.com/book-it.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
qui, l'annotazione `trl.:` usa il codice MARC relativo ai "traduttori".
|
||||
- Usa l virgola `,` per separare ogni elemento nella lista degli autori
|
||||
- Puoi accorciare la lista degli autori scrivendo "`et al.`" (e altri).
|
||||
- Non permettiamo collegamenti per gli autori.
|
||||
- Per le compilation o remix, il "creatore" potrebbe aver bisogno di una descrizione. Ad esempio, i libri "GoalKicker" o "RIP Tutorial" sono accreditati come "`Compiled from StackOverflow documentation`".
|
||||
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@
|
|||
- 만약 오래된 책이라면, 출판일을 제목과 함께 포함하세요.
|
||||
- 작가(들)의 이름을 명시하십시오. "`et al.`"을 사용하여 단축 할 수 있습니다.
|
||||
- 만약 책이 아직 완결되지 않았다면, [아래](#in_process)에 명시되어 있다시피, "`in process`" 표시를 추가하십시오.
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- 만약 이메일 주소 또는 계정 생성이 다운로드 이전에 요청된다면, 별도의 노트를 첨부하세요. 예: `(이메일 주소 *요청됨*, 필요 없음)`.
|
||||
|
||||
|
||||
|
|
@ -130,6 +131,12 @@
|
|||
GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -167,9 +174,17 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
##### 제작자
|
||||
|
||||
- 저희는 무료로 자료들을 배포하는 제작자들(번역가들 포함)에게 감사함을 표합니다!
|
||||
- 번역된 자료들의 경우, 원작자들이 우선적으로 명시되어야 합니다.
|
||||
- 번역된 자료들의 경우, 원작자들이 우선적으로 명시되어야 합니다. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-ko.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- 제작자들의 정보로 향하는 바로가기 주소는 허가되지 않습니다.
|
||||
- 여러 작업물이 조합된 자료의 경우, "제작자"는 설명이 필요할 수 있습니다. 예를 들어, "GoalKicker" 책들의 제작자들은 "`Compiled from StackOverflow documentation`"로 명시되어야 합니다.
|
||||
- 여러 작업물이 조합된 자료의 경우, "제작자"는 설명이 필요할 수 있습니다. 예를 들어, "GoalKicker" or "RIP Tutorial" 책들의 제작자들은 "`Compiled from StackOverflow documentation`"로 명시되어야 합니다.
|
||||
|
||||
|
||||
##### 플랫폼과 접속 노트
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ Ao contribuir você concorda em respeitar o [Código de Conduta](CODE_OF_CONDUCT
|
|||
- se o livro for mais antigo, inclua a data de publicação no título.
|
||||
- inclua o(s) nome(s) do(s) autor(es) onde for apropriado. Você pode encurtar a lista de autores com "`et al`".
|
||||
- se o livro não estiver completo, e ainda está sendo escrito, adicione a notação "`in process`", como descrito [abaixo](#in_process).
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- se um endereço de email ou configuração de conta for solicitado antes que o _download_ seja habilitado, adicione uma observação no idioma apropriado e entre parênteses. Por exemplo: `(endereço de email é *pedido*, não obrigatório)`.
|
||||
|
||||
|
||||
|
|
@ -134,6 +135,12 @@ Exemplo:
|
|||
BOM : * [Será Um Livro Incrível Em Breve](http://exemplo.com/livro2.html) - Fulano de Tal (HTML) (:construction: *em processo*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
BOM : * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -171,9 +178,17 @@ Nossas listas fornecem um conjunto mínimo de metadados: títulos, URLs, criador
|
|||
##### Criadores
|
||||
|
||||
- Queremos creditar os criadores do material gratuito apropriadamente, incluindo tradutores!
|
||||
- Para trabalhos traduzidos, o autor original deve ser creditado.
|
||||
- Para trabalhos traduzidos, o autor original deve ser creditado. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-pt_BR.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Não permitimos _links_ para Criadores.
|
||||
- Para compilações ou trabalhos remixados, o "criador" pode precisar de uma descrição. Por exemplo, os livros "GoalKicker" são creditados como "`Compilado da documento do StackOverflow`" (em inglês: "`Compiled from StackOverflow documentation`").
|
||||
- Para compilações ou trabalhos remixados, o "criador" pode precisar de uma descrição. Por exemplo, os livros "GoalKicker" ou "RIP Tutorial" são creditados como "`Compilado da documento do StackOverflow`" (em inglês: "`Compiled from StackOverflow documentation`").
|
||||
|
||||
|
||||
##### Plataforma e Notas de Acesso
|
||||
|
|
|
|||
|
|
@ -60,6 +60,7 @@
|
|||
- Если книга более старая, укажите дату публикации в названии.
|
||||
- Укажите имя автора или имена там, где это необходимо. Вы можете сократить списки авторов с помощью «`и др.`» («`et al.`»).
|
||||
- если книга не закончена, и работа над ней продолжается, добавьте пометку «`в процессе`», как описано [ниже](#in_process).
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- если перед загрузкой запрашивается адрес электронной почты или настройка учетной записи, добавьте в скобки примечания на соответствующем языке, например: `(адрес электронной почты *запрашивают*, но он не требуется для загрузки)`.
|
||||
|
||||
|
||||
|
|
@ -139,6 +140,12 @@
|
|||
ХОРОШО: * [Скоро будет отличная книга](http://example.com/book2.html) - Джон Доу (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
ХОРОШО: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -181,9 +188,17 @@ If you see a misplaced link, check the linter error message to know which lines
|
|||
##### Creators
|
||||
|
||||
- Хотим поблагодарить создателей бесплатных ресурсов, где это возможно, в том числе переводчиков!
|
||||
- Для переведенных работ следует указать оригинального автора.
|
||||
- Для переведенных работ следует указать оригинального автора. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-ru.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Мы не разрешаем ссылки на авторов.
|
||||
- Для подборок и смешенных изданий «создателю» может потребоваться описание. Например, книги «GoalKicker» считаются «`Скомпилированными из документации StackOverflow`» ("на английском: «`Compiled from StackOverflow documentation`»).
|
||||
- Для подборок и смешенных изданий «создателю» может потребоваться описание. Например, книги «GoalKicker» или «RIP Tutorial» считаются «`Скомпилированными из документации StackOverflow`» ("на английском: «`Compiled from StackOverflow documentation`»).
|
||||
|
||||
|
||||
<!----><a id="platforms-and-access-notes"></a>
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ Bằng cách đóng góp, bạn đồng ý tôn trọng [Quy Tắc Ứng Xử](C
|
|||
- nếu sách cũ, hãy bao gồm ngày xuất bản cùng với tên sách.
|
||||
- bao gồm tên tác giả hoặc tên nếu thích hợp. Bạn có thể rút ngắn danh sách tác giả với "`et al.`".
|
||||
- nếu cuốn sách chưa hoàn thành và vẫn đang được hoàn thiện, hãy thêm ký hiệu "`đang xử lý`", như được mô tả [dưới đây](#in_process).
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
- nếu địa chỉ email hoặc thiết lập tài khoản được yêu cầu trước khi kích hoạt tải xuống, hãy thêm ghi chú phù hợp với ngôn ngữ trong ngoặc đơn, ví dụ: `(địa chỉ email *được yêu cầu*, không bắt buộc)`.
|
||||
|
||||
|
||||
|
|
@ -144,6 +145,12 @@ Ví dụ:
|
|||
TỐT: * [Sách sẽ sớm trở nên tuyệt vời](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
TỐT: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -181,9 +188,17 @@ Danh sách của chúng tôi cung cấp một metadata: tiêu đề, URL, ngư
|
|||
##### Người Sáng Tạo
|
||||
|
||||
- Chúng tôi muốn ghi công những người tạo ra các tài liệu miễn phí nếu thích hợp, bao gồm cả những người dịch!
|
||||
- Đối với các tác phẩm đã dịch, tác giả gốc nên được ghi công.
|
||||
- Đối với các tác phẩm đã dịch, tác giả gốc nên được ghi công. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-vi.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- Chúng tôi không cho phép liên kết bởi Người sáng tạo.
|
||||
- Đối với các tác phẩm tổng hợp hoặc phối lại, "người sáng tạo" có thể cần mô tả. Ví dụ: sách "GoalKicker" được ghi là "`Được tổng hợp từ tài liệu StackOverflow`" (bằng tiếng anh: "`Compiled from StackOverflow documentation`").
|
||||
- Đối với các tác phẩm tổng hợp hoặc phối lại, "người sáng tạo" có thể cần mô tả. Ví dụ: sách "GoalKicker" or "RIP Tutorial" được ghi là "`Được tổng hợp từ tài liệu StackOverflow`" (bằng tiếng anh: "`Compiled from StackOverflow documentation`").
|
||||
|
||||
|
||||
##### Nền Tảng và Ghi Chú Truy Cập
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@
|
|||
* 如果一本书比较旧，请在书名中注明出版日期。
|
||||
* 包含作者的名字或适当的名字。中文版本可以用 “`等`” (“`et al.`”) 缩短作者列表。
|
||||
* 如果一本书还没有完成，并且仍在编写中，则需添加 “`in process`” 符号，参见[下文](#in_process)所述。
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
* 如果在开始下载之前需要电子邮件地址或帐户设置，请在括号中添加合适的语言描述，例如：`(*需要*电子邮件，但不是必须的)`。
|
||||
|
||||
|
||||
|
|
@ -150,6 +151,12 @@
|
|||
正确：* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *翻译中*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
```text
|
||||
正确: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
### Alphabetical order
|
||||
|
||||
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
|
||||
|
|
@ -157,3 +164,115 @@
|
|||
|
||||
If you see a misplaced link, check the linter error message to know which lines should be swapped.
|
||||
|
||||
|
||||
### Notes
|
||||
|
||||
While the basics are relatively simple, there is a great diversity in the resources we list. Here are some notes on how we deal with this diversity.
|
||||
|
||||
|
||||
#### Metadata
|
||||
|
||||
Our lists provide a minimal set of metadata: titles, URLs, creators, platforms, and access notes.
|
||||
|
||||
|
||||
##### Titles
|
||||
|
||||
- No invented titles. We try to take titles from the resources themselves; contributors are admonished not to invent titles or use them editorially if this can be avoided. An exception is for older works; if they are primarily of historical interest, a year in parentheses appended to the title helps users know if they are of interest.
|
||||
- No ALLCAPS titles. Usually title case is appropriate, but when doubt use the capitalization from the source
|
||||
- No emojis.
|
||||
|
||||
|
||||
##### URLs
|
||||
|
||||
- We don't permit shortened URLs.
|
||||
- Tracking codes must be removed from the URL.
|
||||
- International URLs should be escaped. Browser bars typically render these to Unicode, but use copy and paste, please.
|
||||
- Secure (`https`) URLs are always preferred over non-secure (`http`) urls where HTTPS has been implemented.
|
||||
- We don't like URLs that point to webpages that don't host the listed resource, but instead point elsewhere.
|
||||
|
||||
|
||||
##### Creators
|
||||
|
||||
- We want to credit the creators of free resources where appropriate, including translators!
|
||||
- For translated works the original author should be credited. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-zh.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- We do not permit links for Creators.
|
||||
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "`Compiled from StackOverflow documentation`".
|
||||
|
||||
|
||||
##### Platforms and Access Notes
|
||||
|
||||
- Courses. Especially for our course lists, the platform is an important part of the resource description. This is because course platforms have different affordances and access models. While we usually won't list a book that requires a registration, many course platforms have affordances that don't work without some sort of account. Example course platforms include Coursera, EdX, Udacity, and Udemy. When a course depends on a platform, the platform name should be listed in parentheses.
|
||||
- YouTube. We have many courses which consist of YouTube playlists. We do not list YouTube as a platform, we try to list the YouTube creator, which is often a sub-platform.
|
||||
- YouTube videos. We usually don't link to individual YouTube videos unless they are more than an hour long and are structured like a course or a tutorial.
|
||||
- Leanpub. Leanpub hosts books with a variety of access models. Sometimes a book can be read without registration; sometimes a book requires a Leanpub account for free access. Given quality of the books and the mixture and fluidity of Leanpub access models, we permit listing of the latter with the access note `*(Leanpub account or valid email requested)*`.
|
||||
|
||||
|
||||
#### Genres
|
||||
|
||||
The first rule in deciding which list a resource belongs in is to see how the resource describes itself. If it calls itself a book, then maybe it's a book.
|
||||
|
||||
|
||||
##### Genres we don't list
|
||||
|
||||
Because the Internet is vast, we don't include in our lists:
|
||||
|
||||
- blogs
|
||||
- blog posts
|
||||
- articles
|
||||
- websites (except for those that host LOTS of items that we list).
|
||||
- videos that aren't courses or screencasts.
|
||||
- book chapters
|
||||
- teaser samples from books
|
||||
- IRC or Telegram channels
|
||||
- Slacks or mailing lists
|
||||
|
||||
Our competitive programming lists are not as strict about these exclusions. The scope of the repo is determined by the community; if you want to suggest a change or addition to the scope, please use an issue to make the suggestion.
|
||||
|
||||
|
||||
##### Books vs. Other Stuff
|
||||
|
||||
We're not that fussy about book-ness. Here are some attributes that signify that a resource is a book:
|
||||
|
||||
- it has an ISBN (International Standard Book Number)
|
||||
- it has a Table of Contents
|
||||
- a downloadable version is offered, especially ePub files.
|
||||
- it has editions
|
||||
- it doesn't depend on interactive content or videos
|
||||
- it tries to comprehensively cover a topic
|
||||
- it's self-contained
|
||||
|
||||
There are lots of books that we list that don't have these attributes; it can depend on context.
|
||||
|
||||
|
||||
##### Books vs. Courses
|
||||
|
||||
Sometimes these can be hard to distinguish!
|
||||
|
||||
Courses often have associated textbooks, which we would list in our books lists. Courses have lectures, exercises, tests, notes or other didactic aids. A single lecture or video by itself is not a course. A powerpoint is not a course.
|
||||
|
||||
|
||||
##### Interactive Tutorials vs. Other stuff
|
||||
|
||||
If you can print it out and retain its essence, it's not an Interactive Tutorial.
|
||||
|
||||
|
||||
### Automation
|
||||
|
||||
- Formatting rules enforcement is automated via [GitHub Actions](https://github.com/features/actions) using [fpb-lint](https://github.com/vhf/free-programming-books-lint) (see [`.github/workflows/fpb-lint.yml`](../.github/workflows/fpb-lint.yml))
|
||||
- URL validation uses [awesome_bot](https://github.com/dkhamsing/awesome_bot)
|
||||
- To trigger URL validation, push a commit that includes a commit message containing `check_urls=file_to_check`:
|
||||
|
||||
```properties
|
||||
check_urls=free-programming-books.md free-programming-books-zh.md
|
||||
```
|
||||
|
||||
- You may specify more than one file to check, using a single space to separate each entry.
|
||||
- If you specify more than one file, results of the build are based on the result of the last file checked. You should be aware that you may get passing green builds due to this so be sure to inspect the build log at the end of the Pull Request by clicking on "Show all checks" -> "Details".
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@
|
|||
* 如果一本書比較舊，請在書名中註明出版日期。
|
||||
* 包含作者的名字或適當的名字。中文版本可以用 “`等`” (“`et al.`”) 縮短作者列表。
|
||||
* 如果一本書還没有完成，並且仍在編寫中，則需添加 “`in process`” 符號，參考 [下文](#in_process) 所述。
|
||||
- if a resource is restored using the [*Internet Archive's Wayback Machine*](https://web.archive.org) (or similar), add the "`archived`" notation, as described [below](#archived). The best versions to use are recent and complete.
|
||||
* 如果在開始下載之前需要電子郵件地址或帳户設置，請在括號中添加合適的語言描述，例如：`(*需要* 電子郵件，但不是必需的)`。
|
||||
|
||||
|
||||
|
|
@ -150,8 +151,14 @@
|
|||
正確：* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *翻譯中*)
|
||||
```
|
||||
|
||||
- <a id="archived"></a>Archived link:
|
||||
|
||||
### <a id="alphabetical-order"></a>依照字母排序
|
||||
```text
|
||||
正確: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
|
||||
```
|
||||
|
||||
<!----><a id="alphabetical-order"></a>
|
||||
### 依照字母排序
|
||||
|
||||
- 當出現多個相同字母開頭的標題時，則照第二個字母排序，以此類推。例如：`aa` 排在 `ab` 前面
|
||||
- `one two` 排在 `onetwo` 前面
|
||||
|
|
@ -159,7 +166,106 @@
|
|||
如果你看到錯誤的連結，請檢查 linter 的錯誤訊息來找到哪一行順序需要交換
|
||||
|
||||
|
||||
### 自動化測試
|
||||
### Notes
|
||||
|
||||
While the basics are relatively simple, there is a great diversity in the resources we list. Here are some notes on how we deal with this diversity.
|
||||
|
||||
|
||||
#### Metadata
|
||||
|
||||
Our lists provide a minimal set of metadata: titles, URLs, creators, platforms, and access notes.
|
||||
|
||||
|
||||
##### Titles
|
||||
|
||||
- No invented titles. We try to take titles from the resources themselves; contributors are admonished not to invent titles or use them editorially if this can be avoided. An exception is for older works; if they are primarily of historical interest, a year in parentheses appended to the title helps users know if they are of interest.
|
||||
- No ALLCAPS titles. Usually title case is appropriate, but when doubt use the capitalization from the source
|
||||
- No emojis.
|
||||
|
||||
|
||||
##### URLs
|
||||
|
||||
- We don't permit shortened URLs.
|
||||
- Tracking codes must be removed from the URL.
|
||||
- International URLs should be escaped. Browser bars typically render these to Unicode, but use copy and paste, please.
|
||||
- Secure (`https`) URLs are always preferred over non-secure (`http`) urls where HTTPS has been implemented.
|
||||
- We don't like URLs that point to webpages that don't host the listed resource, but instead point elsewhere.
|
||||
|
||||
|
||||
##### Creators
|
||||
|
||||
- We want to credit the creators of free resources where appropriate, including translators!
|
||||
- For translated works the original author should be credited. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book-zh.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- We do not permit links for Creators.
|
||||
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "`Compiled from StackOverflow documentation`".
|
||||
|
||||
|
||||
##### Platforms and Access Notes
|
||||
|
||||
- Courses. Especially for our course lists, the platform is an important part of the resource description. This is because course platforms have different affordances and access models. While we usually won't list a book that requires a registration, many course platforms have affordances that don't work without some sort of account. Example course platforms include Coursera, EdX, Udacity, and Udemy. When a course depends on a platform, the platform name should be listed in parentheses.
|
||||
- YouTube. We have many courses which consist of YouTube playlists. We do not list YouTube as a platform, we try to list the YouTube creator, which is often a sub-platform.
|
||||
- YouTube videos. We usually don't link to individual YouTube videos unless they are more than an hour long and are structured like a course or a tutorial.
|
||||
- Leanpub. Leanpub hosts books with a variety of access models. Sometimes a book can be read without registration; sometimes a book requires a Leanpub account for free access. Given quality of the books and the mixture and fluidity of Leanpub access models, we permit listing of the latter with the access note `*(Leanpub account or valid email requested)*`.
|
||||
|
||||
|
||||
#### Genres
|
||||
|
||||
The first rule in deciding which list a resource belongs in is to see how the resource describes itself. If it calls itself a book, then maybe it's a book.
|
||||
|
||||
|
||||
##### Genres we don't list
|
||||
|
||||
Because the Internet is vast, we don't include in our lists:
|
||||
|
||||
- blogs
|
||||
- blog posts
|
||||
- articles
|
||||
- websites (except for those that host LOTS of items that we list).
|
||||
- videos that aren't courses or screencasts.
|
||||
- book chapters
|
||||
- teaser samples from books
|
||||
- IRC or Telegram channels
|
||||
- Slacks or mailing lists
|
||||
|
||||
Our competitive programming lists are not as strict about these exclusions. The scope of the repo is determined by the community; if you want to suggest a change or addition to the scope, please use an issue to make the suggestion.
|
||||
|
||||
|
||||
##### Books vs. Other Stuff
|
||||
|
||||
We're not that fussy about book-ness. Here are some attributes that signify that a resource is a book:
|
||||
|
||||
- it has an ISBN (International Standard Book Number)
|
||||
- it has a Table of Contents
|
||||
- a downloadable version is offered, especially ePub files.
|
||||
- it has editions
|
||||
- it doesn't depend on interactive content or videos
|
||||
- it tries to comprehensively cover a topic
|
||||
- it's self-contained
|
||||
|
||||
There are lots of books that we list that don't have these attributes; it can depend on context.
|
||||
|
||||
|
||||
##### Books vs. Courses
|
||||
|
||||
Sometimes these can be hard to distinguish!
|
||||
|
||||
Courses often have associated textbooks, which we would list in our books lists. Courses have lectures, exercises, tests, notes or other didactic aids. A single lecture or video by itself is not a course. A powerpoint is not a course.
|
||||
|
||||
|
||||
##### Interactive Tutorials vs. Other stuff
|
||||
|
||||
If you can print it out and retain its essence, it's not an Interactive Tutorial.
|
||||
|
||||
|
||||
### Automation
|
||||
|
||||
- 規定格式驗證是由 [GitHub Actions](https://docs.github.com/en/actions) 自動化進行，使用 [fpb-lint](https://github.com/vhf/free-programming-books-lint) 套件 (參閱 [`.github/workflows/fpb-lint.yml`](../.github/workflows/fpb-lint.yml))。
|
||||
- 使用 [awesome_bot](https://github.com/dkhamsing/awesome_bot) 進行連結驗證。
|
||||
|
|
|
|||
|
|
@ -178,7 +178,15 @@ Our lists provide a minimal set of metadata: titles, URLs, creators, platforms,
|
|||
##### Creators
|
||||
|
||||
- We want to credit the creators of free resources where appropriate, including translators!
|
||||
- For translated works the original author should be credited.
|
||||
- For translated works the original author should be credited. We recommend using [MARC relators](https://loc.gov/marc/relators/relaterm.html) to credit creators other than authors, as in this example:
|
||||
|
||||
```markdown
|
||||
* [A Translated Book](http://example.com/book.html) - John Doe, `trl.:` Mike The Translator
|
||||
```
|
||||
|
||||
here, the annotation `trl.:` uses the MARC relator code for "translator".
|
||||
- Use a comma `,` to delimit each item in the author list.
|
||||
- You can shorten author lists with "`et al.`".
|
||||
- We do not permit links for Creators.
|
||||
- For compilation or remixed works, the "creator" may need a description. For example, "GoalKicker" or "RIP Tutorial" books are credited as "`Compiled from StackOverflow documentation`".
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue