README
¶
wvlist
WVList is a Werke Verzeichnis database available over HTTP(s) with community submissions. It is being hosted by the creator at wvlist.net (onion service), and can be hosted by anyone else as well. This project is intended to be a reference tool for the catalogue complete works list of composers and the numbering list used to identify each composition of a composer, even when ambiguous titles are used. Well-known examples of WV catalogues are Bach Werke Verzeichnis, K numbers used to classify Mozart compositions, and using Opus numbers to classify published compositions.
Dependencies
In addition to the modules imported by the Go compiler, this project requires the Lilypond music engraving software version >2.20.0. This can be installed in many ways. Instructions for how to install Lilypond can be found here.
Installation
- Install Lilypond in your preferred way. Refer to Lilypond installation instructions for compiling from source or installing in another way.
- Clone the repository into your VPS, and change directory into the home directory of this project.
git clone https://github.com/FiskFan1999/wvlist.git && cd wvlist
- Highly recommended: checkout to the latest release instead of unstable HEAD
- Copy the default configuration file.
cp config.default.json config.json
- Change the configuration settings as required. (Refer to
config.txtto describe each ) - Compile the code via
make - Run wvlist via
./wvlist runRefer to instructions about flags (coming soon).
Chat
Please feel free to join the conversation on IRC. (click to open browser client)
Main networks:
irc.ergo.chat:6697 (TLS) #wvlistirc.libera.chat#wvlist- Also available on Matrix at#wvlist:libera.chat
Documentation
¶
Overview ¶
NOTE: HOW TO ADD ADMIN CONSOLE COMMANDS
1. Add a case to the "switch argv[0]" statement in ExecuteAdminCommand 2. (Recommended) call a new function which will handle this command, and pass argv ([]string) to it. This function should return a string. 3. From the switch case, return a string.
Check if the lilypond library is linked correctly (binary is listed correctly in config.json) and give a warning if it is not (but do not stop the program immediately)
This function will be called when the function GetLilypond 404's. Run the lilypond executable to create the file.
Some necessary directories which are not included in the repository (because they begin as empty) will lead to panics while running. Alleviate this by creating these directories if they are not present.
This is called by the homepage function and is used by the home page template
This page serves as the sandbox (/lilysand) Both as the initial page, and for the output of the user-submitted lilypond input.
linkToRepo.go
this file contains the constant of the link to the repo.
If you fork wvlist, you should change this to link to your own repository, otherwise the link will not work.
handlerFunc for viewing a page. such as wvlist.net/view/bach
Source Files
¶
- adminconsole.go
- apiv1.go
- checkForLilypondAtStart.go
- config.go
- constText.go
- createLilypondIncipit.go
- createTempFileWithAllPerms.go
- editPage.go
- fixDirNotfound.go
- getAllLists.go
- getCurrentList.go
- getLilypond.go
- getMux.go
- getRootStaticFile.go
- homePage.go
- lilypondSandbox.go
- linkToRepo.go
- main.go
- params.go
- smtpStuff.go
- submitPage.go
- viewPage.go