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

Pre-beta-1.0 testing required #177

Closed
uliska opened this issue Mar 7, 2018 · 19 comments

Comments

@uliska
Copy link
Collaborator

uliska commented Mar 7, 2018

After intense development (ca. 560 out of 625 changesets have been committed since Jan 15) we are targeting a v1.0 release. The main objective of this version is full compatibility with lilypond-book documents, but it includes much more.

Attached to this issue is lyluatex.pdf, the manual compiled from commit 053f3c6, the current state of the repository.

We ask for review and testing before we will release a v1.0b version to CTAN. When testing the package please keep the following questions in mind:

  • Is the manual comprehensive?
  • Is the manual correct, i.e. does it properly match the behaviour of the package?
  • Is the order of information in the manual useful, is it confusing?
  • Are there any glitches in the resulting output?
  • Do you manage to make the package fail (e.g. produce grossly wrong results, crash)
  • Any real bugs?
  • Should the package have additional features if so we'd specifically need to hear about stuff that should be added immediately, before a v1 release

If you have any comments or observations to report please open issues on this tracker rather than discussing them on mailing lists that linked to this call for review.

@uliska uliska added this to the Release v1 milestone Mar 7, 2018
@uliska uliska referenced this issue Mar 7, 2018
@lemzwerg

This comment has been minimized.

Copy link
Contributor

lemzwerg commented Mar 7, 2018

Nice!

BTW, you should check the example sections in the manual: They are using the wrong single quote and double quote characters (i.e., curved ones instead of straight ones, cf. page 4).

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 7, 2018

(i.e., curved ones instead of straight ones, cf. page 4).

No, that's the Inconsolata font,
image vs.
image

@lemzwerg

This comment has been minimized.

Copy link
Contributor

lemzwerg commented Mar 7, 2018

OK. Assuming that you are using 'InconsolataN' (which is part of TeXLive) I strongly suggest that you activate OpenType feature 'ss01' so that real straight quotes are used.

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 9, 2018

@lemzwerg I'm sorry, but how do I do that with fontspec? From the manual I thought StylisticSet=1 or StylisticSet=01 would be the way to go but both don't make a difference.

@lemzwerg

This comment has been minimized.

Copy link
Contributor

lemzwerg commented Mar 10, 2018

I explicitly wrote 'InconsolataN', not 'Inconsolata' – the latter doesn't contain straight quotes. Saying

\setmonofont[Scale=MatchLowercase, StylisticSet=1]{InconsolataN}

works for me.

uliska added a commit that referenced this issue Mar 10, 2018
@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 10, 2018

Hm, I was sure I had tried all combinations. However, with the last commit it does change the quotes in the manual.

@jperon I think we can close this issue since we didn't receive any objections.

@PunctatorFortunatus

This comment has been minimized.

Copy link

PunctatorFortunatus commented Mar 10, 2018

I'm reading the manual, and I don't think I understand how \betweenLilypondSystems works. I says there that with more programing it is possible to add specific instructions between specific systems, but neither the definition of the command, nor the example in the appendix clarifies this. Thank you all guys for your hard work, you are my favorite people.

@jperon

This comment has been minimized.

Copy link
Owner

jperon commented Mar 10, 2018

Thank you for the report. \betweenLilyPondSystems is documented in LilyPond documentation; I've added the reference in the manual. If you don't define it, it hasn't any default content (\ifx\betweenLilyPondSystems\undefined would return true); it may contain anything you like, so feel free to experiment !

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 10, 2018

I'll update the example to be slightly more expressive.
But actually this is something that doesn't have to be explained in depth by lyluatex.

@PunctatorFortunatus

This comment has been minimized.

Copy link

PunctatorFortunatus commented Mar 10, 2018

Ok, then why not just cross the reference with lilypond manual?

@fedelibre

This comment has been minimized.

Copy link

fedelibre commented Mar 11, 2018

It took me some time to install lyluatex, since I don't have tlmgr on Fedora and I had to learn where to place the files following the TeX Directory Structure. Eventually I came up with this:

$ tree ~/texmf/
/home/fede/texmf/
├── scripts
│   └── lyluatex
│       └── lyluatex.lua
└── tex
    └── latex
        └── lyluatex.sty

4 directories, 2 files

Second, I would add a note about installing TexLive dependencies listed in lyluatex.sty. I had to install also texlive-ctablestack while I was trying to compile a test file.

Now I can compile an example using lualatex --shell-escape luatest.tex, but every time a lilypond snippet is found the ? prompt appears and I have to hit enter to go to the next step. After some Enter(s) I got the PDF file. How can I avoid this?

Thanks for the package, it looks very promising!
BTW, I guess it cannot work around this bug, right?

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 11, 2018

It took me some time to install lyluatex, since I don't have tlmgr on Fedora

OK, some comments to this:

  • tlmgr is only available (IISC) when you install TeXLive from their downloads. When installing from the OS packages you don't use tlmgr but the OS package manager. Probably this has to be verified and clarified in the manual.
  • Currently installing from TeXLive doesn't work because everything we've developed recently isn't there yet. So for testing you have to use the version from the Github repository.

Eventually I came up with this:

For installing from the Github repo you can simply clone the repository anywhere and then link to that location in ~/texmf/tex/latex. This also should be clarified in the manual.

Now I can compile an example using lualatex --shell-escape luatest.tex, but every time a lilypond snippet is found the ? prompt appears and I have to hit enter to go to the next step. After some Enter(s) I got the PDF file. How can I avoid this?

Do you get any scores in the final PDF? What is printed before the ?

BTW, I guess it cannot work around this bug, right?
I don't think so because the cropping is simply achieved by using lilypond-book-preamble.ly, so in that case you'll have to work around the issue in the usual way (by adding content or manually extending the Y-extent of something.

@fedelibre

This comment has been minimized.

Copy link

fedelibre commented Mar 11, 2018

For installing from the Github repo you can simply clone the repository anywhere and then link to that location in ~/texmf/tex/latex. This also should be clarified in the manual.

Ok, this is easier to maintain. I've just made a symlink to the cloned repository, but then lualatex is not recognized:

(/usr/share/texlive/texmf-dist/tex/generic/ifxetex/ifxetex.sty))[\directlua]:1:
 module 'lyluatex.lua' not found:
	no field package.preload['lyluatex.lua']
	[kpse lua searcher] file not found: 'lyluatex.lua'
	[kpse C searcher] file not found: 'lyluatex.lua'
	no file '/usr/local/lib/lua/5.2/lyluatex.so'
	no file '/usr/local/lib/lua/5.2/loadall.so'
	no file './lyluatex.so'
stack traceback:
	[C]: in function 'require'
	[\directlua]:1: in main chunk.
l.94 }
    
?

What's my error?

$ ls -l ~/texmf/tex/latex/
totale 0
lrwxrwxrwx 1 fede fede 24 11 mar 15.05 lyluatex -> /home/fede/src/lyluatex/

$ cd ~/texmf/tex/latex/lyluatex/
[lyluatex (master=)]$ pwd
/home/fede/texmf/tex/latex/lyluatex
[lyluatex (master=)]$ ls
examples  lyluatexbase.cls    lyluatex.md   manual.sh     test-alignment.tex  xml
LICENSE   lyluatex.lua        lyluatex.sty  README.en.md  test.en.tex
ly        lyluatexmanual.cls  Makefile      README.md     test.tex
@fedelibre

This comment has been minimized.

Copy link

fedelibre commented Mar 11, 2018

Now I can compile an example using lualatex --shell-escape luatest.tex, but every time a lilypond snippet is found the ? prompt appears and I have to hit enter to go to the next step. After some Enter(s) I got the PDF file. How can I avoid this?

Do you get any scores in the final PDF? What is printed before the ?

Yes, I get the scores.

Find attached the terminal output.
lyluatest-terminal.log

@jperon

This comment has been minimized.

Copy link
Owner

jperon commented Mar 11, 2018

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 11, 2018

@fedelibre

This comment has been minimized.

Copy link

fedelibre commented Mar 11, 2018

Did you symlink both lyluatex.sty and lyluatex.lua, and did you launch mktexlsr (or texhash) after that ?

I symlinked only the directory. And running mktexlsr after that did not help.

At least on my system, it is necessary to link individual files and there's no need to run mktexlsr.
The following configuration is working correctly:

[~]$ LYLUATEX_SRC=/home/fede/src/lyluatex
[~]$ 
[~]$ echo $LYLUATEX_SRC
/home/fede/src/lyluatex
[~]$ 
[~]$ ln -s $LYLUATEX_SRC/lyluatex.sty ~/texmf/tex/latex/
[~]$ 
[~]$ ln -s $LYLUATEX_SRC/lyluatex.lua ~/texmf/scripts/
[~]$ 
[~]$ tree texmf
texmf
├── scripts
│   └── lyluatex.lua -> /home/fede/src/lyluatex/lyluatex.lua
└── tex
    └── latex
        └── lyluatex.sty -> /home/fede/src/lyluatex/lyluatex.sty

@jperon

This comment has been minimized.

Copy link
Owner

jperon commented Mar 12, 2018

@uliska, if you don't have any objection, I think I'm going to upload to CTAN.

@uliska

This comment has been minimized.

Copy link
Collaborator Author

uliska commented Mar 12, 2018

No, please go ahead. And don't be too modest with the "announcement text" ;-)

@uliska uliska closed this Mar 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.