Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format for submitted links #10

Open
onebree opened this issue Sep 10, 2015 · 15 comments
Open

Format for submitted links #10

onebree opened this issue Sep 10, 2015 · 15 comments

Comments

@onebree
Copy link
Contributor

onebree commented Sep 10, 2015

Unlike programming books, science references have been around for decades, with some subjects rarely updating (math). I think the following should be included when submitting a link

  • Title of work/reference
  • Format of reference (PDF, HTML, Repository, PPT), unless it is a course
  • Author of reference
    • includes PDF, HTML, Repos
    • Excludes wiki-based material (like wikibooks)
  • Year published -- excludes constantly modified works (Wikis, Repos)

I am not sure on the exact format. So far, it looks like @eshellman is formatting it as:

<title> <format> by <author>.

The programming repo does not form it into a sentence, and replaces "by" with " - ".

Any changes we decide here, I will put in my future PR that edits the contributing file.

@eshellman
Copy link
Contributor

Personally I like indications when the target of a link is pdf or epub, i.e. not a web page. Also notations when there's no download - as in [online book]. Also, should make clear that affiliate links are not acceptable.

Also look at: https://sn.reddit.com/r/freeEBOOKS/search?q=flair%3AScience&restrict_sr=on&sort=new&t=all#science

@onebree
Copy link
Contributor Author

onebree commented Sep 10, 2015

Yes, we can assume that references are HTML/webpages, unless otherwise specified. I think we should also note whether accounts are required (like how online courses work). What do you mean by affiliate link? I do not agree with personal accounts like Dropbox, Google Drive, or even torrents.

Maybe we can have a key at the end, full of superscript endnotes? Or even an emoji picture (if there is one)

@eshellman
Copy link
Contributor

affiliate links are those that direct revenue to the linker, i.e. https://affiliate-program.amazon.com/

@onebree
Copy link
Contributor Author

onebree commented Sep 10, 2015

Okay, makes sense... Could you give me an example of a free ebook that is from an affiliate link?

@onebree
Copy link
Contributor Author

onebree commented Sep 10, 2015

Oh, I understand. I know FPB recently added a book that Microsoft released. What about something like that?

Microsoft Press: Free E-Books

@eshellman
Copy link
Contributor

The microsoft press books are fine

@onebree
Copy link
Contributor Author

onebree commented Sep 10, 2015

Okay, I was just making sure... I agree with NO affiliate links then. You have any ideas on a final format per list item?

@eshellman
Copy link
Contributor

Right now, a "final format" would be a premature optimization

@ghost
Copy link

ghost commented Jun 8, 2017

Could we use this format:

for books with 4 authors?

And the book with 2 authors or more?

@eshellman
Copy link
Contributor

sure, "et al."

@ghost
Copy link

ghost commented Jun 8, 2017

All the "." at the end of line could be removed.

@eshellman
Copy link
Contributor

I agree. I will add a linter and travis ci config.

@ghost
Copy link

ghost commented Jun 9, 2017

Can I add this :

?

It's the best link for this book that I found.

@eshellman
Copy link
Contributor

sure. I'm surprised it's not in free programming books.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants