fluid.tour

This tour is a set of examples and tutorials designed to illustrate core features of Fluid and provide a quick start guide to developing applications using Fluid.

This module is the central piece of the tour, gluing it together. It loads and parses each module to display it as a document. It's not trivial; other modules from this package are designed to offer better guidance on Fluid usage, but it might also be useful to people intending to implement similar functionality.

To get started with the tour, use dub run fluid:tour, which should compile and run the tour. The program explains different parts of the library and provides code examples, but you're free to browse through its files if you like! introduction.d might be a good start. I hope this directory proves as a useful learning resource.

Modules

buttons
module fluid.tour.buttons
Undocumented in source.
drag_and_drop
module fluid.tour.drag_and_drop
Undocumented in source.
forms
module fluid.tour.forms
Undocumented in source.
frames
module fluid.tour.frames
Undocumented in source.
introduction
module fluid.tour.introduction
Undocumented in source.
margins
module fluid.tour.margins
Undocumented in source.
module_view
module fluid.tour.module_view

This module exists to test the moduleView component. Content is extracted from documentation comments. Paragraphs can span multiple lines and are separated by a blank line. Leading and trailing whitespace is ignored.

popups
module fluid.tour.popups
Undocumented in source.
slots
module fluid.tour.slots
Undocumented in source.
themes
module fluid.tour.themes
Undocumented in source.

Members

Classes

BuildOutline
class BuildOutline
Undocumented in source.
FunctionVisitor
class FunctionVisitor
Undocumented in source.

Functions

createUI
Space createUI(string initialChapter)
Undocumented in source. Be warned that the author may not have intended to support it.
exampleList
Space exampleList(void delegate(Chapter) @(safe) changeChapter)
Undocumented in source. Be warned that the author may not have intended to support it.
main
void main(string[] args)

The entrypoint prepares themes and the window.

render
Space render(Chapter query)
Space render()

Render the given chapter.

showcaseCode
Space showcaseCode(string code)

Create a code block

showcaseCode
Space showcaseCode(string code, Node node, Theme theme)

Showcase code and its result.

title
string title(Chapter query)

Get the title of the given chapter.

Manifest constants

contentSize
enum contentSize;

Reduced content width, used for document text.

maxContentSize
enum maxContentSize;

Maximum content width, used for code samples, since they require more space.

sidebarSize
enum sidebarSize;

Sidebar width

Variables

codeTheme
Theme codeTheme;
Undocumented in source.
exampleListTheme
Theme exampleListTheme;
Undocumented in source.
highlightBoxTheme
Theme highlightBoxTheme;
Undocumented in source.
mainTheme
Theme mainTheme;
Undocumented in source.
previewWrapperTheme
Theme previewWrapperTheme;
Undocumented in source.

Meta