Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tool categories #1

Open
craigsapp opened this issue Apr 1, 2020 · 1 comment
Open

Tool categories #1

craigsapp opened this issue Apr 1, 2020 · 1 comment
Assignees
Labels

Comments

@craigsapp
Copy link
Member

The main page for the tools now has a list of the command names and brief descriptions of the tool:

https://www2.humdrum.org/tool

This list is generated from the file:

https://github.com/humdrum-tools/newdoc/blob/master/_data/tools.yml

For each tool, there is an entry like:

        - name: "assemble"
          description: "combine parts in two or more Humdrum files"
          tags: 
                - "Humdrum Toolkit"
                - "data processing"

The tags entries are lists of categories that each tool belongs to. These tags are used to create the category selection list on the tools page:

Screen Shot 2020-03-31 at 23 16 22

@shanahdt should go through the list of commands adding additional tags as necessary.

@craigsapp will add Humdrum Extras tools to the list, as well as tools available as VHV filters.

@craigsapp
Copy link
Member Author

Note: when editing the file:

https://github.com/humdrum-tools/newdoc/blob/master/_data/tools.yml

You will likely need to restart the ./.serve command as described in the README for the website to have the updates display properly on the local web server.

Occasionally this will not be enough to update the tool list on the local website, and if that seems to be the case, then stop the .serve command (with control-c), then remove the automatically generated website files in _site with the command:

rm -rf _site

(in the base directory of the website repository).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants