Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: joshlsastro
  • Language: Python
  • Default Branch: master
  • Size: 19.5 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 6 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Citation

README.md

simple_citations

Handbook

My repository for the Simple Citation System. It is based on the system used in "How to Read a Paper", which is cited below in Simple. A citation generator in Python is in citation_maker.py.

How to Use with Zotero

Opening simple.csl or simple-extended.csl will allow you to use Simple or Simple Extended respectively in Zotero.

Caveats: - You'll need to check Cite > Citation Options > Include URLs of paper articles in references in Zotero Settings. - All titles will be in italics; titles of short works will need to be altered to quotes manually. The file specification gives no way to fix this. - Since it's not mentioned in the Handbook, you may reference Simple with in-text citations or notes.

Why Should I Use This?

Simple citations are easier and quicker to write than in other citation systems. Reading them is even easier; you can probably understand all of these examples on first glance without referencing the rest of the Handbook. Simple is also flexible; you can cite pretty much anything from books to news articles to music all in the same format. You can also write Simple citations in plain text or even handwriting; this allows for easy incorporation into websites, notes, or anything else.

In short, using Simple can save you hours of work and can free you from focusing on citations in order to focus on your writing.

Bug Reports or Feature Requests

How to submit a bug report or feature request: 1. Go to github.com and create an account if you don't already have one. 2. Go to Issues and click "New issue". 3. Put your bug report or feature request in the issue you're creating.

Works Cited

Srinivasan Keshav, "How to Read a Paper", http://www.sigcomm.org/sites/default/files/ccr/papers/2007/July/1273445-1273458.pdf

License

Creative Commons License
This work by joshlsastro is licensed under a Creative Commons Attribution 4.0 International License.

Citation (citation_maker.py)

import html # For escaping titles and names

def esc_input(prompt = None):
    return html.escape(input(prompt))

def is_positive_integer(inp):
    """Tests if string inp is a positive integer."""
    if type(inp) != str:
        return False
    try:
        inp = int(inp)
        return inp > 0
    except ValueError:
        return False

print("Note: you probably can create the citation faster using the handbook.")
print("")
num_of_authors = input("How many authors does your work have? ")
if not is_positive_integer(num_of_authors):
    print("Not a valid number of authors.")
    exit()
# Number of authors is now valid
num_of_authors = int(num_of_authors)
authors = esc_input("What is the name of the first author? ")
if num_of_authors == 2:
    authors = authors + " and " + esc_input("What is the name of the second author? ")
if num_of_authors > 2:
    authors = authors + " et al."
# Getting Title
length_of_medium = input("Is the work large(\"l\") or small(\"s\")? ")
length_of_medium = length_of_medium.strip().lower()
title = esc_input("What is the title of the work? ")
if length_of_medium == "l":
    title = "<i>%s</i>" % title
elif length_of_medium == "s":
    title = "&quot;%s&quot;" % title
else:
    print("Not a valid input.")
    exit()
# Getting Locator
type_of_medium = input("Is your medium on the Web(\"w\"), a book(\"b\"), or other(\"o\")? ")
if type_of_medium == "w":
    locator = esc_input("What is the full URL of the work? ")
    locator = "<a href=\"%s\">%s</a>" % (locator,locator)
elif type_of_medium == "b":
    locator = esc_input("What is the ISBN of the book? ")
    locator = "ISBN "+locator
elif type_of_medium == "o":
    locator = ""
else:
    print("Not a valid input.")
    exit()

if locator != "":
    locator = ", "+locator
citation = "<p>"+authors+", "+title+locator

# Simple Extended Citations
extended = input("Do you want to use Simple Extended Citations yes (\"y\") or no (\"n\")? ")
if extended.lower() == "y":
    date = esc_input("What date was the work published on? ")
    container = esc_input("What is the name of the container (e.g. journal, book, larger website) the work is in? ")
    container = "<i>%s</i>" % container
    if container == "<i></i>" or container == title:
        end = "" # No comma if no container
    else:
        end = ", "+container
    citation = citation+", "+date+end

# Writing the citation
citation = citation + "</p>"
filename = input("What file do you want the citation saved to? ")
if not filename.endswith(".html"):
    filename = filename + ".html"
with open(filename, "w") as f:
    f.write(citation)

GitHub Events

Total
Last Year