Adding compositions

Any registered user can add a composition to the Composition Library.

To get started, click on Create new > New composition in the navbar or dropdown menu:

Navbar Create New Dropdown Menu Create New

The Add composition page

The Add composition page

The Add composition page (https://complib.org/composition/add) has a number of fields which allow you to specify certain properties of your custom composition. Click on the name of a tab below to go to a dedicated page explaining how to use it.

General
Specify high-level information about the composition such as its title, composer/arranger, number of parts, and so on.
Methods
Specify which methods are used in the composition, including custom definitions of existing methods and their method mnemonics.
Calls
Define the calls used in the composition, together with their corresponding calling positions. This tab is often not needed, as most compositions use calls which Complib provides by default.
Calling
Edit the calling, or sequence of calls, which defines the composition.
Performances
Add performance information. Mostly used when uploading historical compositions.
References
Link the composition to collections within the Composition Library.

Validating and saving compositions

If Complib is able to parse the composition as entered, then its generated title, composition layout and blue line will be displayed at the bottom of the page. Complib will automatically attempt to validate any composition it can parse. Clicking the Validate button will force a re-validation.

A composition which passes validation can be saved as a private composition by clicking the Save button. If the composition does not pass validation, one or more validation errors will be displayed. The composition layout and blue line displays will highlight certain specific errors, to aid in troubleshooting. Non-critical warnings may also be given.

Validation errors

Composition errors

If Complib encounters a critical problem when attempting to validate the composition, an error message will be displayed. All errors must be cleared before a composition can be saved.

There are a number of different error types. Most errors will give an indication of how to clear them. The following is a non-exhaustive list of some of the more common errors:

Error: Composition is false and cannot be saved unless overriden in the General tab

The composition as specified is false (that is, not true). See Composition properties > Truth for an explanation of what it means for a composition to be true.

Since the vast majority of compositions which change ringers want to ring are true, Complib will not allow false compositions to be saved and published by default. However, this behaviour can be overridden with Allow save if false under the General tab.

A false composition will be indicated with a Icon: false next to the title on its composition page and in search results.

Error: Composition is not a round block.

The composition as specified does not end at the same row it started from. There are various things which can cause this to happen, but most often it is due to a mistake in the calling.

Error: Rounds reached with unprocessed calls.

The composition as pricked reaches rounds before the composition's calling (as defined under the Calling tab) has been finished.

There are a number of different reasons you might be seeing this error:

Number of Extents is too small
If the value of General > Extents has been set incorrectly, Complib may expect the composition to finish earlier than it should. If your composition contains multiple extents, you should check that the Extents value reflects that.
Mistakes in the calling
The calling itself may contain errors. See Calling > Troubleshooting for help debugging your composition's calling.
Incorrect coursehead mask(s)
Coursehead mask(s) may have not been set correctly, leading to the calling being misinterpreted.
Error: Unable to prick composition, or other errors need to be cleared.

Complib is not able to prick (generate the rows of) the composition as it has been defined. Usually this means that some other error is preventing Complib from parsing the composition.

Error: Maximum false row limit reached.

Complib will not automatically stop pricking a composition as soon as it runs false. However, in order to prevent the pricker from entering an infinite loop, there is an upper limit on the number of false rows which will be generated. This error means that the composition has reached that upper limit, and no more rows will be pricked in the blue line display.

Validation warnings

Composition warnings

When validating a composition, Complib may generate one or more warnings. These contain information about the composition which you may wish to take into account before saving and/or publishing it. However, warnings by themselves do not prevent compositions from being saved.

Tab-specific warnings and errors

A number of warnings and errors relate to specific tabs in the composition editor. In such cases, the validation readout will list the tab which is responsible for causing the warning or error.

Information on how to clear tab-specific warnings and errors can be found on the Help pages for each tab, accessible via the sidebar. See above for a brief description of the tabs.

Layout display

A parsed composition will be laid out by Complib at the bottom of the page. For an overview of the various parts of a composition layout, see Composition pages > Layout.

The appearance of the layout is determined by the current configuration of the composition layout options. The layout options can be adjusted by clicking on the Icon: cogcog next to the Validate button.

Note

The format in which another user sees the composition is determined exclusively by their own display settings. The appearance of the Layout display and Blue line on the Add composition page have no bearing on how a composition is saved, and will not affect how it will appear to other users.

However, adjusting the Layout display and Blue line options here can help you to see how the composition might appear to users with different configurations, and can be useful when debugging the composition if it is not pricking correctly.

Blue line

Underneath the layout of a parsed composition, Complib will also give the pricked rows of the composition in a dedicated Blue line tab. The tab can be expanded by clicking on its name. When expanded, it will look something like this:

Composition blue line example

The appearance of the blue line display is determined by the blue line display options you have configured. These can be adjusted by clicking on the Icon: cogcog at the top right of the tab.

For more info on the blue line display for compositions, see Composition pages > Blue line.

Publishing compositions

A custom composition which is successfully saved to Complib becomes a private composition and is given its own composition page. Private compositions are only visible to their owners, until they are published or shared via public link.

To publish a private composition, click the Icon: publishPublish button in the toolbar at the top of the composition page. This will add the composition to Complib's Public library, so that it is visible to anyone using the site.

Warning

A published composition cannot be un-published (though it can still be edited or deleted). You should make sure that you want a composition to be visible before publishing it.

Normally, a private composition is only visible to the user who owns it. However, you might want to share your private composition with others. You can do this by sharing via a public link.

To generate a public link, click on the Icon: shareshare button in the toolbar at the top of the composition's page. This will open a window containing a link which you can copy to your clipboard.

Sharing a private composition via public link does not publish it. If you want your private composition to be visible to anyone who uses Complib, you should consider publishing it instead.

Editing and deleting compositions

To edit a custom composition, click on the Icon: editedit button in the toolbar. This will open the composition in the editor, allowing you to change its various properties.

To delete a custom composition, click on the Icon: deletedelete button in the toolbar. This will bring up a prompt asking you to confirm that you want to delete the composition. Clicking on Confirm Delete will delete the composition from Complib.

Warning

Unlike deleted methods, compositions are deleted immediately and can no longer be recovered. If you have shared the composition via a public link, or if the composition has been linked to from an external site such as BellBoard, the link will no longer function.

You should exercise great caution when deleting a composition which has been shared publicly, especially if there is any possibility of its being rung. If a composition has already been rung, you should avoid deleting it altogether. If deletion is absolutely necessary, then you should supply a redirection to another Complib presentation of the same composition (see below).

Redirecting external references

As noted above, Complib allows various external sites such as BellBoard to reference public compositions via their Composition Id. Deleting a composition will break any external links which reference it.

The delete confirmation prompt lets you specify another composition which any such external links should be redirected to: simply enter the alternative composition's Composition Id in the provided text box. The Composition Id can be found in the Library Details tab on its composition page; it is also the string of numbers at the end of the composition page URL.

Warning

The redirection process cannot be undone, unless the new composition is also one that you own. You should be certain that the new composition is an appropriate substitute for the old one before redirecting.