article

package

v0.7.0 Latest Latest Go to latest Published: Aug 2, 2023 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Milover/fetchref

Links

Open Source Insights

Documentation ¶

Index ¶

func SnakeCaseGenerator(a *Article) string
type Article
type Handle
- func (h Handle) String() string
type HandleType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SnakeCaseGenerator ¶

func SnakeCaseGenerator(a *Article) string

SnakeCaseGenerator is generates a snake-case file name from the Article title. All punctuation, spaces and control codes are replaced by '_'s, which are squeezed. No extension is added to the file name.

Types ¶

type Article ¶

type Article struct {
	Handle   Handle // article identifier DOI, ISBN, ISSN...
	DOI      string
	Title    string
	Url      *url.URL // PDF download link
	Citation []byte
	// contains filtered or unexported fields
}

The Article holds data needed to download and write the article to disc. The DOI is used to fetch the title and PDF URL from Sci-Hub.

func (*Article) GenerateFileName ¶

func (a *Article) GenerateFileName() string

GenerateFileName generates and caches the file name of the article.

func (*Article) GeneratorFunc ¶

func (a *Article) GeneratorFunc(g fileNameFunc)

GeneratorFunc assigns a new generator

func (*Article) Reset ¶

func (a *Article) Reset()

Reset resets all article data.

type Handle ¶

type Handle struct {
	Value string
	Type  HandleType
}

func (Handle) String ¶

func (h Handle) String() string

type HandleType ¶

type HandleType int

const (
	DOI HandleType = iota
	ISBN
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL