diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +# 0.2.0.0 + +* Descriptions of shortcuts look much better now. +* “sublime” was renamed to “sublimepc”, since it's possible that some other package manager for Sublime Text would emerge in the future. +* Shortcut “tvt” for TV Tropes was removed – it's just “tvtropes” now. +* “facebook” can link to profiles by their ID. +* “tvtropes” properly capitalises names of categories (if given as an option) – previously you needed to write e.g. “SugarWiki”, now “sugar wiki” works too. + # 0.1.0.0 First release. diff --git a/shortcut-links.cabal b/shortcut-links.cabal --- a/shortcut-links.cabal +++ b/shortcut-links.cabal @@ -1,9 +1,9 @@ name: shortcut-links -version: 0.1.0.0 +version: 0.2.0.0 synopsis: Link shortcuts for use in text markup description: This package is a database of link shortcuts. A Markdown example: - @[Google](\@w)@ turns into . + @\[Google\](\@w)@ turns into . homepage: http://github.com/aelve/shortcut-links bug-reports: http://github.com/aelve/shortcut-links/issues license: BSD3 diff --git a/src/ShortcutLinks/All.hs b/src/ShortcutLinks/All.hs --- a/src/ShortcutLinks/All.hs +++ b/src/ShortcutLinks/All.hs @@ -90,697 +90,977 @@ type Shortcut = Maybe Text -> Text -> Result Text --- | A list of all functions included in this module, together with suggested --- names for them. -allShortcuts :: [([Text], Shortcut)] -allShortcuts = - let (.=) names func = (T.words names, func) - in [ - -- encyclopedias - "w wikipedia" .= wikipedia, - "tvt tvtropes" .= tvtropes, - -- social networks - "fb facebook" .= facebook, - "vk vkontakte" .= vk, - "gp gplus googleplus" .= googleplus, - -- microblogs - "t twitter" .= twitter, - "juick" .= juick, - -- search engines - "google" .= google, - "ddg duckduckgo" .= duckduckgo, - "yandex" .= yandex, - "baidu" .= baidu, - -- programming language libraries - "npm" .= npm, - "jam" .= jam, - "gem" .= rubygems, - "pypi" .= pypi, - "cpan" .= metacpanPod, - "cpan-r" .= metacpanRelease, - "hackage" .= hackage, - "cargo" .= cargo, - "pub" .= pub, - "hex" .= hex, - "cran" .= cran, - "swiprolog" .= swiprolog, - "dub" .= dub, - "bpkg" .= bpkg, - "pear" .= pear, - -- code hosting - "gh github" .= github, - "gitlab" .= gitlab, - "bitbucket" .= bitbucket, - -- OS - "gplay googleplay" .= googleplay, - "chocolatey" .= chocolatey, - "brew" .= braumeister, - -- OS – Linux - "debian" .= debian, - "aur" .= aur, - "mint" .= mint, - "fedora" .= fedora, - "gentoo" .= gentoo, - "opensuse" .= opensuse, - -- text editors - "marmalade" .= marmalade, - "melpa" .= melpa, - "elpa" .= elpa, - "sublime" .= packagecontrol, - "atom" .= atomPackage, - "atom-theme" .= atomTheme, - "jedit" .= jedit, - "vim" .= vim, - -- browsers - "opera" .= operaExt, - "opera-theme" .= operaTheme, - "firefox" .= firefox, - "chrome" .= chrome, - -- manuals - "ghc-ext" .= ghcExt, - -- standards and databases - "rfc" .= rfc, - "ecma" .= ecma, - "cve" .= cve ] - --- | --- --- Link example: --- @[green](\@fb)@ → --- -facebook :: Shortcut -facebook _ q = return $ "https://facebook.com/" <> q - --- | (Вконтакте) --- --- Link example (username): --- @[green](\@vk)@ → --- --- --- Link example (ID): --- --- @[1337](\@vk)@ → --- -vk :: Shortcut -vk _ q = return $ "https://vk.com/" <> q' - where q' = if not (T.null q) && isDigit (T.head q) then "id" <> q else q - --- | --- --- Link example (username): --- @[SergeyBrin](\@gp)@ → --- --- --- Link example (username with @+@): --- @[+SergeyBrin](\@gp)@ → --- --- --- Link example (full name – will just be concatenated): --- @[Sergey Brin](\@gp)@ → --- --- --- Link example (ID): --- @[Sergey Brin](\@gp:109813896768294978296)@ → --- --- --- Link example (hashtag): --- @[#Australia](\@gp)@ → --- -googleplus :: Shortcut -googleplus _ q - | T.null q = return $ url - | T.head q == '#' = return $ format "{}/explore/{}" url (T.tail q) - | T.head q == '+' = return $ format "{}/{}" url q - | T.all isDigit q = return $ format "{}/{}" url q - | otherwise = return $ format "{}/+{}" url (T.concat (T.words q)) - where url = "https://plus.google.com" - --- | --- --- Link example (username): --- @[kmett](\@t)@ → --- --- --- Link example (username with @\@@): --- @[\@kmett](\@t)@ → --- --- --- Link example (hashtag): --- @[#haskell](\@t)@ → --- -twitter :: Shortcut -twitter _ q - | T.null q = return $ url - | T.head q == '#' = return $ format "{}/hashtag/{}" url (T.tail q) - | T.head q == '@' = return $ format "{}/{}" url (T.tail q) - | otherwise = return $ format "{}/{}" url q - where url = "https://twitter.com" - --- | --- --- Link example (username): --- @[thefish](\@juick)@ → --- --- --- Link example (username with @\@@): --- @[\@thefish](\@juick)@ → --- --- --- Link example (tag): --- @[*Haskell](\@juick)@ → --- -juick :: Shortcut -juick _ q - | T.null q = return $ url - | T.head q == '*' = return $ format "{}/tag/{}" url (T.tail q) - | T.head q == '@' = return $ format "{}/{}" url (T.tail q) - | otherwise = return $ format "{}/{}" url q - where url = "https://juick.com" - --- | --- --- Link example: --- @[random query](\@google)@ → --- -google :: Shortcut -google _ q = return $ - "https://google.com/search?nfpr=1&q=" <> replaceSpaces '+' q - --- | --- --- Link example: --- @[random query](\@ddg)@ → --- -duckduckgo :: Shortcut -duckduckgo _ q = return $ "https://duckduckgo.com/?q=" <> replaceSpaces '+' q - --- | (Russian search engine) --- --- Link example: --- @[random query](\@yandex)@ → --- -yandex :: Shortcut -yandex _ q = return $ - "http://yandex.ru/search/?noreask=1&text=" <> replaceSpaces '+' q - --- | (Chinese search engine) --- --- Link example: --- @[random query](\@baidu)@ → --- -baidu :: Shortcut -baidu _ q = return $ "http://baidu.com/s?nojc=1&wd=" <> replaceSpaces '+' q - --- | __Node.js__ – --- --- Link example: --- @[markdown](\@npm)@ → --- -npm :: Shortcut -npm _ q = return $ "https://npmjs.com/package/" <> q - --- | __Javascript__ – --- --- Link example: --- @[pagedown](\@jam)@ → --- -jam :: Shortcut -jam _ q = return $ "http://jamjs.org/packages/#/details/" <> q - --- | __Ruby__ – --- --- Link example: --- @[github-markdown](\@gem)@ → --- -rubygems :: Shortcut -rubygems _ q = return $ "https://rubygems.org/gems/" <> q - --- | __Python__ – --- --- Link example: --- @[Markdown](\@pypi)@ → --- -pypi :: Shortcut -pypi _ q = return $ "https://pypi.python.org/pypi/" <> q - --- | __Perl__ – (by module) --- --- Link example: --- @[Text::Markdown](\@cpan)@ → --- -metacpanPod :: Shortcut -metacpanPod _ q = return $ "https://metacpan.org/pod/" <> q - --- | __Perl__ – (by release) --- --- Link example: --- @[Text-Markdown](\@cpan-r)@ → --- -metacpanRelease :: Shortcut -metacpanRelease _ q = return $ "https://metacpan.org/release/" <> q - --- | __Haskell__ – --- --- Link example: --- @[cmark](\@hackage)@ → --- -hackage :: Shortcut -hackage _ q = return $ "https://hackage.haskell.org/package/" <> q - --- | __Rust__ – --- --- Link example: --- @[hoedown](\@cargo)@ → --- -cargo :: Shortcut -cargo _ q = return $ "https://crates.io/crates/" <> q - --- | __PHP__ – --- --- Link example: --- @[Text_Wiki_Doku](\@pear)@ → --- -pear :: Shortcut -pear _ q = return $ "http://pear.php.net/package/" <> q - --- | __Dart__ – --- --- Link example: --- @[md_proc](\@pub)@ → --- -pub :: Shortcut -pub _ q = return $ "https://pub.dartlang.org/packages/" <> q - --- | __R__ – --- --- Link example: --- @[markdown](\@cran)@ → --- -cran :: Shortcut -cran _ q = return $ "http://cran.r-project.org/web/packages/" <> q - --- | __Erlang__ – --- --- Link example: --- @[earmark](\@hex)@ → --- -hex :: Shortcut -hex _ q = return $ "https://hex.pm/packages/" <> q - --- | __SWI-Prolog__ – --- --- Link example: --- @[markdown](\@swiprolog)@ → --- -swiprolog :: Shortcut -swiprolog _ q = return $ "http://www.swi-prolog.org/pack/list?p=" <> q - --- | __D__ – --- --- Link example: --- @[dmarkdown](\@dub)@ → --- -dub :: Shortcut -dub _ q = return $ "http://code.dlang.org/packages/" <> q - --- | __Bash__ – --- --- Link example: --- @[markdown](\@bpkg)@ → --- -bpkg :: Shortcut -bpkg _ q = return $ "http://bpkg.io/pkg/" <> q - --- | --- --- Link example: --- @[aelve/shortcut-links](\@gh)@ → --- --- --- The repository owner can also be given as an option: --- --- @[shortcut-links](\@gh(aelve))@ → --- -github :: Shortcut -github mbOwner q = case mbOwner of - Nothing -> return $ format "https://github.com/{}" q - Just owner -> return $ format "https://github.com/{}/{}" owner q - --- | --- --- Link example: --- @[bos/text](\@bitbucket)@ → --- --- --- The repository owner can also be given as an option: --- --- @[text](\@bitbucket(bos))@ → --- -bitbucket :: Shortcut -bitbucket mbOwner q = case mbOwner of - Nothing -> return $ format "https://bitbucket.org/{}" q - Just owner -> return $ format "https://bitbucket.org/{}/{}" owner q - --- | --- --- Link example: --- @[learnyou/lysa](\@gitlab)@ → --- --- --- The repository owner can also be given as an option: --- --- @[lysa](\@gitlab(learnyou))@ → --- --- --- Note that links like work but are going to be --- automatically redirected to either or --- , depending on whether it's a user or a --- team. So, it's a case when the “links have to look as authentic as --- possible” principle is violated (but c'mon, this “u” thing looks ugly --- anyway). -gitlab :: Shortcut -gitlab mbOwner q = case mbOwner of - Nothing -> return $ format "https://gitlab.com/{}" q - Just owner -> return $ format "https://gitlab.com/{}/{}" owner q - --- | __Android__ – (formerly Play Market) --- --- Link example: --- @[Opera Mini](\@gplay:com.opera.mini.native)@ → --- -googleplay :: Shortcut -googleplay _ q = return $ "https://play.google.com/store/apps/details?id=" <> q - --- | (Homebrew formulas) --- --- Link example: --- @[multimarkdown](\@brew)@ → --- -braumeister :: Shortcut -braumeister _ q = return $ "http://braumeister.org/formula/" <> q - --- | --- --- Link example: --- @[Opera](\@chocolatey)@ → --- -chocolatey :: Shortcut -chocolatey _ q = return $ "https://chocolatey.org/packages/" <> q - --- | __Debian__ – --- --- Link example (stable distribution): --- @[ghc](\@debian)@ → --- --- --- Link example (experimental distribution, but could be any other): --- @[ghc](\@debian(experimental))@ → --- -debian :: Shortcut -debian mbDist q = return $ format "https://packages.debian.org/{}/{}" dist q - where - dist = fromMaybe "stable" mbDist - --- | __Arch Linux__ – (“user repository”) --- --- Link example: --- @[ghc-git](\@aur)@ → --- -aur :: Shortcut -aur _ q = return $ "https://aur.archlinux.org/packages/" <> q - --- | __Gentoo__ – --- --- Link example: --- @[dev-lang/ghc](\@gentoo)@ → --- --- --- Link example (category as an option): --- @[ghc](\@gentoo(dev-lang))@ → --- --- --- Note that if you don't specify any category, the link would still work – --- but there are a lot of packages with overlapping names (like “ace”, “csv”, --- “http”), and such links would lead to search pages listing several --- packages. So, it's better to include categories. -gentoo :: Shortcut -gentoo mbCat q = return $ "https://packages.gentoo.org/package/" <> pkg - where - pkg = case mbCat of - Nothing -> q - Just cat -> cat <> "/" <> q - --- | __openSUSE__ – --- --- Link example: --- @[ghc](\@opensuse)@ → --- -opensuse :: Shortcut -opensuse _ q = return $ "http://software.opensuse.org/package/" <> q - --- | __Linux Mint__ – --- --- Link example: --- @[ghc](\@mint)@ → --- -mint :: Shortcut -mint _ q = return $ "http://community.linuxmint.com/software/view/" <> q - --- | __Fedora__ – --- --- Link example: --- @[ghc](\@fedora)@ → --- -fedora :: Shortcut -fedora _ q = return $ "https://admin.fedoraproject.org/pkgdb/package/" <> q - --- | __Emacs__ – --- --- Link example: --- @[markdown-mode](\@marmalade)@ → --- -marmalade :: Shortcut -marmalade _ q = return $ "https://marmalade-repo.org/packages/" <> q - --- | __Emacs__ – --- --- Link example: --- @[markdown-mode](\@melpa)@ → --- -melpa :: Shortcut -melpa _ q = return $ "http://melpa.org/#/" <> q - --- | __Emacs__ – --- --- Link example: --- @[undo-tree](\@elpa)@ → --- -elpa :: Shortcut -elpa _ q = return $ format "https://elpa.gnu.org/packages/{}.html" q - --- | __Sublime Text__ – --- --- Link example: --- @[MarkdownEditing](\@sublime)@ → --- -packagecontrol :: Shortcut -packagecontrol _ q = return $ "https://packagecontrol.io/packages/" <> q - --- | __Atom__ – --- --- Link example: --- @[tidy-markdown](\@atom)@ → --- -atomPackage :: Shortcut -atomPackage _ q = return $ "https://atom.io/packages/" <> q - --- | __Atom__ – --- --- Link example: --- @[atom-material-ui](\@atom-theme)@ → --- -atomTheme :: Shortcut -atomTheme _ q = return $ "https://atom.io/themes/" <> q - --- | __jEdit__ – --- --- Link example: --- @[MarkdownPlugin](\@jedit)@ → --- -jedit :: Shortcut -jedit _ q = return $ "http://plugins.jedit.org/plugins/?" <> q - --- | __Vim__ – --- --- Link example (ID): --- @[haskell.vim](\@vim:2062)@ → --- -vim :: Shortcut -vim _ q = return $ "http://www.vim.org/scripts/script.php?script_id=" <> q - --- | __Opera__ – --- --- Link example: --- @[Amazon](\@opera:amazon-for-opera)@ → --- -operaExt :: Shortcut -operaExt _ q = return $ "https://addons.opera.com/extensions/details/" <> q - --- | __Opera__ – --- --- Link example: --- @[Space theme](\@opera-theme:space-15)@ → --- -operaTheme :: Shortcut -operaTheme _ q = return $ "https://addons.opera.com/themes/details/" <> q - --- | __Firefox__ – (extensions, themes) --- --- Link example: --- @[tree-style-tab]@ → --- -firefox :: Shortcut -firefox _ q = return $ "https://addons.mozilla.org/firefox/addon/" <> q - --- | __Chrome__ – (extensions, apps, themes) --- --- Link example: --- @[hdokiejnpimakedhajhdlcegeplioahd]@ → --- -chrome :: Shortcut -chrome _ q = return $ "https://chrome.google.com/webstore/detail/" <> q - --- | (Glasgow Haskell Compiler) extensions --- --- Link example: --- @[ViewPatterns](\@ghc-ext)@ → --- -ghcExt :: Shortcut -ghcExt _ ext = case lookup ext ghcExtsList of - Nothing -> fail (format "unknown GHC extension '{}'" ext) - Just link -> return link - --- | --- --- Link example: --- @[RFC 2026](\@rfc)@ → --- --- --- Precise format of recognised text: optional “rfc” (case-insensitive), then --- arbitrary amount of spaces and punctuation (or nothing), then the --- number. Examples: “RFC 2026”, “RFC-2026”, “rfc2026”, “rfc #2026”, “2026”, --- “#2026”. -rfc :: Shortcut -rfc _ x = do - let n = T.dropWhile (not . isAlphaNum) (tryStripPrefixCI "rfc" x) - -- We don't use 'readMaybe' here because 'readMaybe' isn't available in GHC - -- 7.4, which Pandoc has to be compatible with. - unless (T.all isDigit n) $ - warn "non-digits in RFC number" - when (T.null n) $ - warn "no RFC number" - let n' = T.dropWhile (== '0') n `orElse` "0" - return ("https://tools.ietf.org/html/rfc" <> n') - --- | --- --- Link example (standard): --- @[ECMA-262](\@ecma)@ → --- --- --- Link example (technical report): --- @[TR/71](\@ecma)@ → --- --- --- Precise format of recognised text for standards: optional “ECMA” --- (case-insensitive), then arbitrary amount of spaces and punctuation (or --- nothing), then the number. Examples: “ECMA-262”, “ECMA 262”, “ecma262”, --- “ECMA #262”, “262”, “#262”. --- --- Format for technical reports is the same, except that “TR” (instead of --- “ECMA”) is not optional (so, if there's only a number given, it's --- considered a standard and not a technical report). -ecma :: Shortcut -ecma _ q = do - -- TODO: move dropSeparators to Utils and use it in 'rfc' and 'cve' - let dropSeparators = T.dropWhile (not . isAlphaNum) - let (dropSeparators -> mbNum, isTR) = case stripPrefixCI "tr" q of - Nothing -> (tryStripPrefixCI "ecma" q, False) - Just q' -> (q', True) - -- We don't use 'readMaybe' here because 'readMaybe' isn't available in GHC - -- 7.4, which Pandoc has to be compatible with. - unless (T.all isDigit mbNum) $ - warn "non-digits in ECMA standard number" - when (T.null mbNum) $ - warn "no ECMA standard number" - -- The number has to have at least 3 digits. - let num = T.justifyRight 3 '0' mbNum - url = "http://ecma-international.org/publications" :: Text - return $ if isTR - then format "{}/techreports/E-TR-{}.htm" url num - else format "{}/standards/Ecma-{}.htm" url num - --- | (Common Vulnerabilities and Exposures) --- --- Link example: --- @[CVE-2014-10001](\@cve)@ → --- --- --- Precise format of recognised text: optional “cve” (case-insensitive), then --- arbitrary amount of spaces and punctuation (or nothing), then the year, --- ‘-’, and a number. Examples: “CVE-2014-10001”, “cve 2014-10001”, --- “2014-10001”. -cve :: Shortcut -cve _ x = do - let n = T.dropWhile (not . isAlphaNum) (tryStripPrefixCI "cve" x) - unless (T.length n >= 9) $ - warn "CVE-ID is too short" - let isValid = and [ - T.length n >= 9, - T.all isDigit (T.take 4 n), - T.index n 4 == '-', - T.all isDigit (T.drop 5 n) ] - unless isValid $ - warn "CVE-ID doesn't follow the - format" - return ("http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-" <> n) - --- | --- --- Link example (English Wikipedia): --- @[grey-headed flying fox](\@w)@ → --- --- --- Link example (Russian Wikipedia, but any language code can be used): --- @[Haskell](\@w(ru))@ → --- -wikipedia :: Shortcut -wikipedia mbLang q = return $ - format "https://{}.wikipedia.org/wiki/{}" lang q' - where - lang = fromMaybe "en" mbLang - q' = titleFirst (replaceSpaces '_' q) - --- | --- --- Link example (trope): --- @[so bad, it's good](\@tvtropes)@ → --- --- --- Link example (series): --- @[Elementary](\@tvtropes(series))@ → --- --- --- You can give anything as a category instead of “series”, it'll be --- capitalised but nothing else. -tvtropes :: Shortcut -tvtropes mbCat q = return $ - format "http://tvtropes.org/pmwiki/pmwiki.php/{}/{}" cat q' - where - cat = maybe "Main" titleFirst mbCat - isSep c = (isSpace c || isPunctuation c) && c /= '\'' - -- Break into words, transform each word like “it's” → “Its”, and concat. - -- Note that e.g. “man-made” is considered 2 separate words. - q' = T.concat $ map (titleFirst . T.filter isAlphaNum) (T.split isSep q) +{- | +A list of all functions included in this module, together with suggested names for them. +-} +allShortcuts :: [([Text], Shortcut)] +allShortcuts = + let (.=) names func = (T.words names, func) + in [ + -- encyclopedias + "w wikipedia" .= wikipedia, + "tvtropes" .= tvtropes, + -- social networks + "fb facebook" .= facebook, + "vk vkontakte" .= vk, + "gp gplus googleplus" .= googleplus, + -- microblogs + "t twitter" .= twitter, + "juick" .= juick, + -- search engines + "google" .= google, + "ddg duckduckgo" .= duckduckgo, + "yandex" .= yandex, + "baidu" .= baidu, + -- programming language libraries + "npm" .= npm, + "jam" .= jam, + "gem" .= rubygems, + "pypi" .= pypi, + "cpan" .= metacpanPod, + "cpan-r" .= metacpanRelease, + "hackage" .= hackage, + "cargo" .= cargo, + "pub" .= pub, + "hex" .= hex, + "cran" .= cran, + "swiprolog" .= swiprolog, + "dub" .= dub, + "bpkg" .= bpkg, + "pear" .= pear, + -- code hosting + "gh github" .= github, + "gitlab" .= gitlab, + "bitbucket" .= bitbucket, + -- OS + "gplay googleplay" .= googleplay, + "chocolatey" .= chocolatey, + "brew" .= braumeister, + -- OS – Linux + "debian" .= debian, + "aur" .= aur, + "mint" .= mint, + "fedora" .= fedora, + "gentoo" .= gentoo, + "opensuse" .= opensuse, + -- text editors + "marmalade" .= marmalade, + "melpa" .= melpa, + "elpa" .= elpa, + "sublimepc" .= packagecontrol, + "atom" .= atomPackage, + "atom-theme" .= atomTheme, + "jedit" .= jedit, + "vim" .= vim, + -- browsers + "opera" .= operaExt, + "opera-theme" .= operaTheme, + "firefox" .= firefox, + "chrome" .= chrome, + -- manuals + "ghc-ext" .= ghcExt, + -- standards and databases + "rfc" .= rfc, + "ecma" .= ecma, + "cve" .= cve ] + +{- | + +Link by username: + +@ +\[green\](\@fb) + +@ + +Or by profile ID (are there still people without usernames, actually?): + +@ +\[someone something\](\@fb:164680686880529) + +@ +-} +facebook :: Shortcut +facebook _ q + | T.all isDigit q = return $ "https://facebook.com/profile.php?id=" <> q + | otherwise = return $ "https://facebook.com/" <> q + +{- | (Вконтакте) + +Link by username: + +@ +\[green\](\@vk) + +@ + +Or by ID: + +@ +\[Durov\](\@vk:1) + +@ +-} +vk :: Shortcut +vk _ q + | T.all isDigit q = return $ "https://vk.com/id" <> q + | otherwise = return $ "https://vk.com/" <> q + +{- | + +Link by username: + +@ +\[SergeyBrin\](\@gp) + +@ + +It's alright if the username already starts with a “+”: + +@ +\[+SergeyBrin\](\@gp) + +@ + +Since many usernames are just “your full name without spaces”, in many cases you can give a name and it's easy to make a username from it: + +@ +\[Sergey Brin\](\@gp) + +@ + +You can also link by ID: + +@ +\[Sergey Brin\](\@gp:109813896768294978296) + +@ + +Finally, there are different links for hashtags: + +@ +\[#Australia\](\@gp) + +@ +-} +googleplus :: Shortcut +googleplus _ q + | T.null q = return $ url + | T.head q == '#' = return $ format "{}/explore/{}" url (T.tail q) + | T.head q == '+' = return $ format "{}/{}" url q + | T.all isDigit q = return $ format "{}/{}" url q + | otherwise = return $ format "{}/+{}" url (T.concat (T.words q)) + where url = "https://plus.google.com" + +{- | + +Link by username: + +@ +\[Edward Kmett\](\@t:kmett) + +@ + +It's alright if the username already starts with a “\@”: + +@ +\[\@kmett\](\@t) + +@ + +There are different links for hashtags: + +@ +\[#haskell\](\@t) + +@ +-} +twitter :: Shortcut +twitter _ q + | T.null q = return $ url + | T.head q == '#' = return $ format "{}/hashtag/{}" url (T.tail q) + | T.head q == '@' = return $ format "{}/{}" url (T.tail q) + | otherwise = return $ format "{}/{}" url q + where url = "https://twitter.com" + +{- | + +Link by username: + +@ +\[thefish\](\@juick) + +@ + +It's alright if the username already starts with a “\@”: + +@ +\[\@thefish\](\@juick) + +@ + +There are different links for tags (which start with “\*” and not with “#”, by the way): + +@ +\[*Haskell\](\@juick) + +@ +-} +juick :: Shortcut +juick _ q + | T.null q = return $ url + | T.head q == '*' = return $ format "{}/tag/{}" url (T.tail q) + | T.head q == '@' = return $ format "{}/{}" url (T.tail q) + | otherwise = return $ format "{}/{}" url q + where url = "https://juick.com" + +{- | + +Search results: + +@ +\[random query\](\@google) + +@ +-} +google :: Shortcut +google _ q = return $ + "https://google.com/search?nfpr=1&q=" <> replaceSpaces '+' q + +{- | + +Search results: + +@ +\[random query\](\@ddg) + +@ +-} +duckduckgo :: Shortcut +duckduckgo _ q = return $ "https://duckduckgo.com/?q=" <> replaceSpaces '+' q + +{- | (Russian search engine) + +Search results: + +@ +\[random query\](\@yandex) + +@ +-} +yandex :: Shortcut +yandex _ q = return $ + "http://yandex.ru/search/?noreask=1&text=" <> replaceSpaces '+' q + +{- | (Chinese search engine) + +Search results: + +@ +\[random query\](\@baidu) + +@ +-} +baidu :: Shortcut +baidu _ q = return $ "http://baidu.com/s?nojc=1&wd=" <> replaceSpaces '+' q + +{- | __Node.js__ – + +Link to a package: + +@ +\[markdown\](\@npm) + +@ +-} +npm :: Shortcut +npm _ q = return $ "https://npmjs.com/package/" <> q + +{- | __Javascript__ – + +Link to a package: + +@ +\[pagedown\](\@jam) + +@ +-} +jam :: Shortcut +jam _ q = return $ "http://jamjs.org/packages/#/details/" <> q + +{- | __Ruby__ – + +Link to a package: + +@ +\[github-markdown\](\@gem) + +@ +-} +rubygems :: Shortcut +rubygems _ q = return $ "https://rubygems.org/gems/" <> q + +{- | __Python__ – + +Link to a package: + +@ +\[Markdown\](\@pypi) + +@ +-} +pypi :: Shortcut +pypi _ q = return $ "https://pypi.python.org/pypi/" <> q + +{- | __Perl__ – (by module) + +Link to a module: + +@ +\[Text::Markdown\](\@cpan) + +@ + +To link to a release, look at 'metacpanRelease'. +-} +metacpanPod :: Shortcut +metacpanPod _ q = return $ "https://metacpan.org/pod/" <> q + +{- | __Perl__ – (by release) + +Link to a release: + +@ +\[Text-Markdown\](\@cpan-r) + +@ +-} +metacpanRelease :: Shortcut +metacpanRelease _ q = return $ "https://metacpan.org/release/" <> q + +{- | __Haskell__ – + +Link to a package: + +@ +\[cmark\](\@hackage) + +@ +-} +hackage :: Shortcut +hackage _ q = return $ "https://hackage.haskell.org/package/" <> q + +{- | __Rust__ – + +Link to a package: + +@ +\[hoedown\](\@cargo) + +@ +-} +cargo :: Shortcut +cargo _ q = return $ "https://crates.io/crates/" <> q + +{- | __PHP__ – + +Link to a package: + +@ +\[Text_Wiki_Doku\](\@pear) + +@ +-} +pear :: Shortcut +pear _ q = return $ "http://pear.php.net/package/" <> q + +{- | __Dart__ – + +Link to a package: + +@ +\[md_proc\](\@pub) + +@ +-} +pub :: Shortcut +pub _ q = return $ "https://pub.dartlang.org/packages/" <> q + +{- | __R__ – + +Link to a package: + +@ +\[markdown\](\@cran) + +@ +-} +cran :: Shortcut +cran _ q = return $ "http://cran.r-project.org/web/packages/" <> q + +{- | __Erlang__ – + +Link to a package: + +@ +\[earmark\](\@hex) + +@ +-} +hex :: Shortcut +hex _ q = return $ "https://hex.pm/packages/" <> q + +{- | __SWI-Prolog__ – + +Link to a package: + +@ +\[markdown\](\@swiprolog) + +@ +-} +swiprolog :: Shortcut +swiprolog _ q = return $ "http://www.swi-prolog.org/pack/list?p=" <> q + +{- | __D__ – + +Link to a package: + +@ +\[dmarkdown\](\@dub) + +@ +-} +dub :: Shortcut +dub _ q = return $ "http://code.dlang.org/packages/" <> q + +{- | __Bash__ – + +Link to a package: + +@ +\[markdown\](\@bpkg) + +@ +-} +bpkg :: Shortcut +bpkg _ q = return $ "http://bpkg.io/pkg/" <> q + +{- | + +Link to a user: + +@ +\[Aelve\](\@gh:aelve) + +@ + +Link to a repository: + +@ +\[aelve/shortcut-links\](\@gh) + +@ + +The repository owner can also be given as an option (to avoid mentioning nem in the link text): + +@ +\[shortcut-links\](\@gh(aelve)) + +@ +-} +github :: Shortcut +github mbOwner q = case mbOwner of + Nothing -> return $ format "https://github.com/{}" q + Just owner -> return $ format "https://github.com/{}/{}" owner q + +{- | + +Link to a user: + +@ +\[Bryan\](\@bitbucket:bos) + +@ + +Link to a repository: + +@ +\[bos/text\](\@bitbucket) + +@ + +The repository owner can also be given as an option (to avoid mentioning nem in the link text): + +@ +\[text\](\@bitbucket(bos)) + +@ +-} +bitbucket :: Shortcut +bitbucket mbOwner q = case mbOwner of + Nothing -> return $ format "https://bitbucket.org/{}" q + Just owner -> return $ format "https://bitbucket.org/{}/{}" owner q + +{- | + +Link to a user or a team (note that links like work but are going to be automatically redirected to either or , depending on whether it's a user or a team – so, it's a case when the “links have to look as authentic as possible” principle is violated, but nothing can be done with that): + +@ +\[CyanogenMod\](\@bitbucket) + +@ + +Link to a repository: + +@ +\[learnyou/lysa\](\@gitlab) + +@ + +The repository owner can also be given as an option (to avoid mentioning nem in the link text): + +@ +\[lysa\](\@gitlab(learnyou)) + +@ +-} +gitlab :: Shortcut +gitlab mbOwner q = case mbOwner of + Nothing -> return $ format "https://gitlab.com/{}" q + Just owner -> return $ format "https://gitlab.com/{}/{}" owner q + +{- | __Android__ – (formerly Play Market) + +Link to an app: + +@ +\[Opera Mini\](\@gplay:com.opera.mini.native) + +@ +-} +googleplay :: Shortcut +googleplay _ q = return $ "https://play.google.com/store/apps/details?id=" <> q + +{- | (Homebrew formulas) + +Link to a formula: + +@ +\[multimarkdown\](\@brew) + +@ +-} +braumeister :: Shortcut +braumeister _ q = return $ "http://braumeister.org/formula/" <> q + +{- | + +Link to a package: + +@ +\[Opera\](\@chocolatey) + +@ +-} +chocolatey :: Shortcut +chocolatey _ q = return $ "https://chocolatey.org/packages/" <> q + +{- | __Debian__ – + +Link to a package in stable distribution: + +@ +\[ghc\](\@debian) + +@ + +Distribution can be given as an option: + +@ +\[ghc\](\@debian(experimental)) + +@ +-} +debian :: Shortcut +debian mbDist q = return $ format "https://packages.debian.org/{}/{}" dist q + where + dist = fromMaybe "stable" mbDist + +{- | __Arch Linux__ – (“user repository”) + +Link to a package: + +@ +\[ghc-git\](\@aur) + +@ +-} +aur :: Shortcut +aur _ q = return $ "https://aur.archlinux.org/packages/" <> q + +{- | __Gentoo__ – + +Link to a package: + +@ +\[dev-lang/ghc\](\@gentoo) + +@ + +Category can be given as an option, to avoid cluttering link text: + +@ +\[ghc\](\@gentoo(dev-lang)) + +@ + +Note that if you don't specify any category, the link would still work – but there are a lot of packages with overlapping names (like “ace”, “csv”, “http”), and such links would lead to search pages listing several packages. So, it's better to include categories. +-} +gentoo :: Shortcut +gentoo mbCat q = return $ "https://packages.gentoo.org/package/" <> pkg + where + pkg = case mbCat of + Nothing -> q + Just cat -> cat <> "/" <> q + +{- | __openSUSE__ – + +Link to a package: + +@ +\[ghc\](\@opensuse) + +@ +-} +opensuse :: Shortcut +opensuse _ q = return $ "http://software.opensuse.org/package/" <> q + +{- | __Linux Mint__ – + +Link to a package: + +@ +\[ghc\](\@mint) + +@ +-} +mint :: Shortcut +mint _ q = return $ "http://community.linuxmint.com/software/view/" <> q + +{- | __Fedora__ – + +Link to a package: + +@ +\[ghc\](\@fedora) + +@ +-} +fedora :: Shortcut +fedora _ q = return $ "https://admin.fedoraproject.org/pkgdb/package/" <> q + +{- | __Emacs__ – + +Link to a package: + +@ +\[markdown-mode\](\@marmalade) + +@ +-} +marmalade :: Shortcut +marmalade _ q = return $ "https://marmalade-repo.org/packages/" <> q + +{- | __Emacs__ – + +Link to a package: + +@ +\[markdown-mode\](\@melpa) + +@ +-} +melpa :: Shortcut +melpa _ q = return $ "http://melpa.org/#/" <> q + +{- | __Emacs__ – + +Link to a package: + +@ +\[undo-tree\](\@elpa) + +@ +-} +elpa :: Shortcut +elpa _ q = return $ format "https://elpa.gnu.org/packages/{}.html" q + +{- | __Sublime Text__ – + +Link to a package: + +@ +\[MarkdownEditing\](\@sublimepc) + +@ +-} +packagecontrol :: Shortcut +packagecontrol _ q = return $ "https://packagecontrol.io/packages/" <> q + +{- | __Atom__ – + +Link to a package: + +@ +\[tidy-markdown\](\@atom) + +@ +-} +atomPackage :: Shortcut +atomPackage _ q = return $ "https://atom.io/packages/" <> q + +{- | __Atom__ – + +Link to a theme: + +@ +\[atom-material-ui\](\@atom-theme) + +@ +-} +atomTheme :: Shortcut +atomTheme _ q = return $ "https://atom.io/themes/" <> q + +{- | __jEdit__ – + +Link to a plugin: + +@ +\[MarkdownPlugin\](\@jedit) + +@ +-} +jedit :: Shortcut +jedit _ q = return $ "http://plugins.jedit.org/plugins/?" <> q + +{- | __Vim__ – + +Link to a script (by ID): + +@ +\[haskell.vim\](\@vim:2062) + +@ +-} +vim :: Shortcut +vim _ q = return $ "http://www.vim.org/scripts/script.php?script_id=" <> q + +{- | __Opera__ – + +Link to an extension: + +@ +\[Amazon\](\@opera:amazon-for-opera) + +@ +-} +operaExt :: Shortcut +operaExt _ q = return $ "https://addons.opera.com/extensions/details/" <> q + +{- | __Opera__ – + +Link to a theme: + +@ +\[Space theme\](\@opera-theme:space-15) + +@ +-} +operaTheme :: Shortcut +operaTheme _ q = return $ "https://addons.opera.com/themes/details/" <> q + +{- | __Firefox__ – + +Link to an extension (or a theme): + +@ +\[tree-style-tab](\@firefox) + +@ +-} +firefox :: Shortcut +firefox _ q = return $ "https://addons.mozilla.org/firefox/addon/" <> q + +{- | __Chrome__ – + +Link to an extension, app, or theme (using that weird random-looking ID): + +@ +\[hdokiejnpimakedhajhdlcegeplioahd](\@chrome) + +@ +-} +chrome :: Shortcut +chrome _ q = return $ "https://chrome.google.com/webstore/detail/" <> q + +{- | (Glasgow Haskell Compiler) extensions + +Link to an extension's description in the user manual: + +@ +\[ViewPatterns\](\@ghc-ext) + +@ +-} +ghcExt :: Shortcut +ghcExt _ ext = case lookup ext ghcExtsList of + Nothing -> fail (format "unknown GHC extension '{}'" ext) + Just link -> return link + +{- | + +Link to an RFC: + +@ +\[RFC 2026\](\@rfc) + +@ + +Precise format of recognised text: optional “rfc” (case-insensitive), then arbitrary amount of spaces and punctuation (or nothing), then the number. Examples: “RFC 2026”, “RFC-2026”, “rfc2026”, “rfc #2026”, “2026”, “#2026”. +-} +rfc :: Shortcut +rfc _ x = do + let n = T.dropWhile (not . isAlphaNum) (tryStripPrefixCI "rfc" x) + -- We don't use 'readMaybe' here because 'readMaybe' isn't available in GHC + -- 7.4, which Pandoc has to be compatible with. + unless (T.all isDigit n) $ + warn "non-digits in RFC number" + when (T.null n) $ + warn "no RFC number" + let n' = T.dropWhile (== '0') n `orElse` "0" + return ("https://tools.ietf.org/html/rfc" <> n') + +{- | + +Link to a standard: + +@ +\[ECMA-262\](\@ecma) + +@ + +Link to a technical report: + +@ +\[TR/71\](\@ecma) + +@ + +Precise format of recognised text for standards: optional “ECMA” (case-insensitive), then arbitrary amount of spaces and punctuation (or nothing), then the number. Examples: “ECMA-262”, “ECMA 262”, “ecma262”, “ECMA #262”, “262”, “#262”. + +Format for technical reports is the same, except that “TR” (instead of “ECMA”) is not optional (so, if there's only a number given, it's considered a standard and not a technical report). +-} +ecma :: Shortcut +ecma _ q = do + -- TODO: move dropSeparators to Utils and use it in 'rfc' and 'cve' + let dropSeparators = T.dropWhile (not . isAlphaNum) + let (dropSeparators -> mbNum, isTR) = case stripPrefixCI "tr" q of + Nothing -> (tryStripPrefixCI "ecma" q, False) + Just q' -> (q', True) + -- We don't use 'readMaybe' here because 'readMaybe' isn't available in GHC + -- 7.4, which Pandoc has to be compatible with. + unless (T.all isDigit mbNum) $ + warn "non-digits in ECMA standard number" + when (T.null mbNum) $ + warn "no ECMA standard number" + -- The number has to have at least 3 digits. + let num = T.justifyRight 3 '0' mbNum + url = "http://ecma-international.org/publications" :: Text + return $ if isTR + then format "{}/techreports/E-TR-{}.htm" url num + else format "{}/standards/Ecma-{}.htm" url num + +{- | (Common Vulnerabilities and Exposures) + +Link to a CVE: + +@ +\[CVE-2014-10001\](\@cve) + +@ + +Precise format of recognised text: optional “cve” (case-insensitive), then arbitrary amount of spaces and punctuation (or nothing), then the year, “-”, and a number. Examples: “CVE-2014-10001”, “cve 2014-10001”, “2014-10001”. +-} +cve :: Shortcut +cve _ x = do + let n = T.dropWhile (not . isAlphaNum) (tryStripPrefixCI "cve" x) + unless (T.length n >= 9) $ + warn "CVE-ID is too short" + let isValid = and [ + T.length n >= 9, + T.all isDigit (T.take 4 n), + T.index n 4 == '-', + T.all isDigit (T.drop 5 n) ] + unless isValid $ + warn "CVE-ID doesn't follow the - format" + return ("http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-" <> n) + +{- | + +Link to an article in English Wikipedia: + +@ +\[grey-headed flying fox\](\@w) + +@ + +You can link to Wikipedia-in-another-language if you give language code as an option: + +@ +\[Haskell\](\@w(ru)) + +@ +-} +wikipedia :: Shortcut +wikipedia mbLang q = return $ + format "https://{}.wikipedia.org/wiki/{}" lang q' + where + lang = fromMaybe "en" mbLang + q' = titleFirst (replaceSpaces '_' q) + +{- | + +Link to a trope: + +@ +\[so bad, it's good\](\@tvtropes) + +@ + +Link to anything else (a series, for example): + +@ +\[Elementary\](\@tvtropes(series)) + +@ + +Or something on Sugar Wiki: + +@ +\[awesome music\](\@tvtropes(sugar wiki)) + +@ +-} +tvtropes :: Shortcut +tvtropes mbCat q = return $ + format "http://tvtropes.org/pmwiki/pmwiki.php/{}/{}" cat (camel q) + where + isSep c = (isSpace c || isPunctuation c) && c /= '\'' + -- Break into words, transform each word like “it's” → “Its”, and concat. + -- Note that e.g. “man-made” is considered 2 separate words. + camel = T.concat . map (titleFirst . T.filter isAlphaNum) . T.split isSep + cat = maybe "Main" camel mbCat ghcExtsList :: [(Text, Text)] ghcExtsList = do