Documentation ¶
Overview ¶
Package links provides a data type for links.
Index ¶
- type Link
- func (link *Link) Address() string
- func (link *Link) Classes() (classes string)
- func (link *Link) Display() string
- func (link *Link) Exists() bool
- func (link *Link) Href() string
- func (link *Link) ImgSrc() string
- func (link *Link) ItExists() *Link
- func (link *Link) OfKind(kind LinkType) bool
- func (link *Link) String() string
- type LinkType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Link ¶
type Link struct { DestinationKnown bool // contains filtered or unexported fields }
Link is an abstraction for universal representation of links, be they links in mycomarkup links or whatever.
func (*Link) Classes ¶
Classes returns CSS class string for given link. It is not wrapped in any quotes, wrap yourself.
func (*Link) Exists ¶ added in v0.2.0
Exists is true if the link should be blue, not red. Red links are links to hyphae that do not exist, all other links are blue.
func (*Link) Href ¶
Href returns content for the href attrubute for hyperlink. You should always use it.
type LinkType ¶
type LinkType int
LinkType tells what type the given link is.
const ( // LinkInvalid is an error state for LinkType. LinkInvalid LinkType = iota // LinkLocalRoot is a link like "/list", "/user-list", etc. LinkLocalRoot // LinkLocalHypha is a link like "test", "../test", etc. LinkLocalHypha // LinkExternal is an external link with specified protocol. LinkExternal // LinkInterwiki is currently left unused. In the future it will be used for interwiki links. LinkInterwiki )
Click to show internal directories.
Click to hide internal directories.