package
1.5.21
Repository: https://github.com/defacto2/server.git
Documentation: pkg.go.dev

# Packages

Package remote provides the remote download and update of artifact data from third-party sources such as API's.

# Functions

Artifact404 renders the error page for the artifact links.
Artifacts is the handler for the list and preview of the files page.
Artifacts404 renders the files error page for the Artifacts menu and categories.
Artist is the handler for the Artist sceners page.
Attribute returns a formatted string of the roles for the given scener name.
BadRequestErr is the handler for handling Bad Request Errors, caused by invalid user input or a malformed client requests.
BBS is the handler for the BBS page ordered by the most files.
BBSAZ is the handler for the BBS page ordered alphabetically.
BBSYear is the handler for the BBS page ordered by the year.
Brief returns a human readable brief description of the combined platform and section.
ByteFile returns a human readable string of the file count and bytes.
ByteFileS returns a human readable string of the byte count with a named description.
Categories is the handler for the artifact categories page.
Checksum is the handler for the Checksum file record page.
Code is the handler for the Coder sceners page.
Collection of Milestones from the 1970s onwards.
Configurations is the handler for the Configuration page.
DatabaseErr is the handler for database connection issues.
Day returns a string representation of the day number, a value between 1 and 31.
Deletions is the handler to list the files that have been marked for deletion.
Describe returns a human readable description of a release.
Download is the handler for the Download file record page.
DownloadErr is the handler for missing download files and database ID errors.
DownloadJsDos is the handler for the js-dos emulator to download zip files that are then mounted as a C: hard drive in the emulation.
EmptyTester is a map of defaults for the app template tests.
FileMissingErr is the handler for missing download files and database ID errors.
Names returns the absolute path of the public facing font files relative to the embed.FS root.
FontRefs returns the relative path of the public facing font files.
ForApproval is the handler for the list and preview of the files page.
ForbiddenErr is the handler for handling Forbidden Errors, caused by clients requesting pages that they do not have permission to access.
FTP is the handler for the FTP page.
GetDemozoo fetches the download link from Demozoo and saves it to the download directory.
GetDemozooParam fetches the multiple download_links values from the Demozoo production API and attempts to download and save one of the linked files.
GetPouet fetches the download link from Pouet and saves it to the download directory.
GlobTo returns the path to the template file.
GoogleCallback is the handler for the Google OAuth2 callback page to verify the [Google ID token].
HasPrefix returns true if the string s ends with the suffix.
History is the handler for the History page.
Hrefs returns the relative path of the public facing CSS, JS and WASM files.
Index is the handler for the Home page.
Inline is the handler for the Download file record page.
InternalErr is the handler for handling Internal Server Errors, caused by programming bugs or crashes.
Interview is the handler for the People Interviews page.
Interviewees returns a list of interviewees and their interviews.
LastUpdated returns a string of the time since the given time t.
LinkDownload creates a URL to link to the file download of the record.
LinkHref creates a URL path to link to the file page for the record.
LinkInterview returns a SVG arrow icon to indicate an interview link hosted on an external website.
LinkPage creates a URL anchor element to link to the file page for the record.
LinkPreview creates a URL to link to the file record in-tab to use as a preview.
LinkPreviews returns a slice of HTML formatted links for the artifact editor.
LinkBothReleasers returns the groups associated with a release and a link to each group.
LinkRelrs returns the groups associated with a release and a link to each group.
LinkRels returns the groups associated with a release and a link to each group.
LinkRelsPerf returns the groups associated with a release and a link to each group.
LinkRemote returns a HTML link with an embedded SVG icon to an external website.
LinkRunApp creates a URL anchor element to link to the artifact page to launch the js-dos emulator.
LinkScnr returns a link to the named scener page.
LinkScnr...
LinkWiki returns a HTML link with an embedded SVG icon to the Defacto2 wiki on GitHub.
List is a collection of websites grouped by a category.
LogoText returns a string of text padded with spaces to center it in the logo.
Magazine is the handler for the Magazine page.
MagazineAZ is the handler for the Magazine page ordered chronologically.
Month returns a short string of the month.
Musician is the handler for the Musiciansceners page.
Names returns the absolute path of the public facing CSS, JS and WASM files relative to the [embed.FS] root.
New is the handler for the what is new page.
Page404 renders the files page error page for the Artifacts menu and categories.
PlatformEdit handles the post submission for the Platform selection field.
PlatformTagInfo handles the POST submission for the platform and tag info.
PostDesc is the handler for the Search for file descriptions form post page.
PostFilename is the handler for the Search for filenames form post page.
PostName is the handler for the Search for filenames form post page.
PouetCache parses the cached data for the Pouet production votes.
Prefix returns a string prefixed with a space.
ProdPouet is the handler for the Pouet prod JSON page.
ProdZoo is the handler for the Demozoo production JSON page.
RecordRels returns the groups associated with a release and joins them using a plus sign.
Releaser is the handler for the releaser page ordered by the most files.
Releaser404 renders the files error page for the Groups menu and invalid releasers.
ReleaserAZ is the handler for the releaser page ordered alphabetically.
Releasers is the handler for the list and preview of files credited to a releaser.
ReleaserYear is the handler for the releaser page ordered by year of the first release.
SafeHTML returns a string as a template.HTML type to prevent HTML escaping in the template.
SafeJS returns a string as a template.JS type to prevent JavaScript escaping in the template.
Scener is the handler for the page to list all the sceners.
Scener404 renders the files error page for the People menu and invalid sceners.
Sceners is the handler for the list and preview of files credited to a scener.
SearchDesc is the handler for the Search for file descriptions page.
SearchFile is the handler for the Search for files page.
SearchID is the handler for the Record by ID Search page.
SearchReleaser is the handler for the Releaser Search page.
SignedOut is the handler to sign out and remove the current session.
Signin is the handler for the Sign in session page.
SignOut is the handler for the Sign out of Defacto2 page.
StatusErr is the handler for the HTTP status pages such as the 404 - not found.
SubTitle returns a secondary element with the record title.
TagBrief returns a small summary of the tag.
TagEdit handles the post submission for the Tag selection field.
TagInfo handles the POST submission for the platform and tag info.
TagOption returns a HTML option tag with a "selected" attribute if the s matches the value.
TagWithOS returns a small summary of the tag with the operating system.
Thanks is the handler for the Thanks page.
TheScene is the handler for the The Scene page.
Titles is the handler for the Titles page.
TrimSiteSuffix returns a string with the last 4 characters removed if they are " FTP" or " BBS".
TrimSpace returns a string with all leading and trailing whitespace removed.
Unwanted is the handler to list the files that have been marked as unwanted.
URLEncode returns a URL encoded string from the given string.
VotePouet is the handler for the Pouet production votes JSON page.
Website is the handler for the websites page.
WebsiteIcon returns a Bootstrap icon name for the given website url.
Writer is the handler for the Writer page.
YMDEdit handles the post submission for the Year, Month, Day selection fields.

# Constants

A1200 is the path to the Topaz Plus font file.
A1200TT is the path to the Topaz Plus legacy TrueType format font file.
A1200Woff is the path to the Topaz Plus legacy WOFF format font file.
Bootstrap is the path to the minified Bootstrap 5.3 CSS file.
BootstrapJS is the path to the minified Bootstrap 5.3 JS file.
BootstrapIcons is the path to the custom Bootstrap Icons SVG sprites file.
CascadiaMono is the path to the Cascadia Mono font file.
CascadiaMonoTT is the path to the Cascadia Mono TrueType format font file.
CascadiaMonoWoff is the path to the Cascadia Mono WOFF format font file.
Descriptions is the search for file descriptions and titles.
DosboxJS is the js-dos v6 default variant compiled with emscripten.
DosboxWasm is the js-dos v6 WASM binary file.
EditArtifact is the path to the minified Artifact Editor JS file.
EditAssets is the path to the minified Editor assets JS file.
EditForApproval is the path to the minified Editor for-approval JS file.
Filenames is the search for filenames.
Htmx is the path to the minified htmx AJAX JS file.
Htmx is the path to the minified response targets extension file.
Jsdos6JS is the path to the minified js-dos v6 JS file.
Layout is the path to the minified layout CSS file.
LayoutJS is the path to the minified layout JS file.
Pouet is the path to the minified Pouet JS file.
Readme is the path to the minified Readme JS file.
Uploader is the path to the minified Uploader JS file.
VGA8 is the path to the IBM VGA 8px font file.
VGA8TT is the path to the IBM VGA 8px legacy TrueType format font file.
VGA8Woff is the path to the IBM VGA 8px legacy WOFF format font file.
Welcome is the default logo monospace text, each side contains 20 whitespace characters.

# Variables

nolint:gochecknoglobals.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Cache contains database values that are used throughout the app or layouts, but do not change frequently enough to warrant a database query on every page load.
Dirs contains the directories used by the artifact pages.
Form is the form data for the editor.
Group is a collection of interviews with members of a group.
Interviewee is a person who was interviewed with a link to the interview.
Milestone is an accomplishment for a year and optional month.
No description provided by the author
Picture is an image or screenshot for a milestone.
Site is a website.
SRI are the Subresource Integrity hashes for the layout.
Templ is the configuration and status of the web application templates.

# Type aliases

Accordion is a collection of websites grouped by a category.
Asset is a relative path to a public facing CSS, JS or WASM file.
FileSearch is the type of search to perform.
Font is a relative path to a public facing font file.
Fonts are a map of the public facing font files.
Groups is a collection of group interviews.
Interviews is a collection of Interviewee.
Links is a collection of Links.
Milestones is a collection of Milestone.
Paths are a map of the public facing CSS, JS and WASM files.
Sites is a collection of websites.