README
¶
Cogent Content
Cogent Content is a package for making content-focused apps and websites consisting of Markdown, HTML, and Cogent Core.
References
Wikilink styles for scientific source references are supported, using the csl Citation Style Language format, with one citation per wikilink:
-
[[@CiteKey]]generates aParentheticalcitation, e.g., for APA style it is like: "Smith & Jones, 1989", which should be put in parentheses along with any others, e.g.,([[@SmithJones89]]; [[@West05]]). -
[[@^CiteKey]]generates aNarrativecitation, where the citation serves as the subject of the sentence. For APA style this is: "Smith & Jones (1989)".
Documentation
¶
Overview ¶
Package content provides a system for making content-focused apps and websites consisting of Markdown, HTML, and Cogent Core.
Index ¶
- Variables
- type Content
- func (ct *Content) Init()
- func (ct *Content) MakeToolbar(p *tree.Plan)
- func (ct *Content) MenuSearch(items *[]core.ChooserItem)
- func (ct *Content) Open(url string) *Content
- func (ct *Content) SetContent(content fs.FS) *Content
- func (t *Content) SetReferences(v *csl.KeyList) *Content
- func (ct *Content) SetSource(source fs.FS) *Content
Constants ¶
This section is empty.
Variables ¶
var NewPageInitFunc func()
NewPageInitFunc is called when a new page is just being rendered. This can do any necessary new-page initialization, e.g., [yaegicore.ResetGoalInterpreter]
Functions ¶
This section is empty.
Types ¶
type Content ¶
type Content struct {
core.Splits
// Source is the source filesystem for the content.
// It should be set using [Content.SetSource] or [Content.SetContent].
Source fs.FS `set:"-"`
// Context is the [htmlcore.Context] used to render the content,
// which can be modified for things such as adding wikilink handlers.
Context *htmlcore.Context `set:"-"`
// References is a list of references used for generating citation text
// for literature reference wikilinks in the format [[@CiteKey]].
References *csl.KeyList
// contains filtered or unexported fields
}
Content manages and displays the content of a set of pages.
func NewContent ¶
NewContent returns a new Content with the given optional parent: Content manages and displays the content of a set of pages.
func (*Content) MakeToolbar ¶
func (*Content) MenuSearch ¶
func (ct *Content) MenuSearch(items *[]core.ChooserItem)
func (*Content) Open ¶
Open opens the page with the given URL and updates the display. If no pages correspond to the URL, it is opened in the default browser.
func (*Content) SetContent ¶
SetContent is a helper function that calls Content.SetSource with the "content" subdirectory of the given filesystem.
func (*Content) SetReferences ¶
SetReferences sets the [Content.References]: References is a list of references used for generating citation text for literature reference wikilinks in the format [[@CiteKey]].
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bcontent ("base content") provides base types and functions shared by both content and the core build tool for content.
|
Package bcontent ("base content") provides base types and functions shared by both content and the core build tool for content. |
|
examples
|
|
|
basic
command
|