Pimp codeexamples (issue #640) #711

Mo-Gul · 2019-07-16T16:59:54Z

everything important is written in the comments to issue #640.

…s in `extract.lua` - started adding libraries to the codeexamples

(so far not all needed styles and definitions were added using `pre` key)

…r files fail TeXing using the build bash script. ! `pre` stuff containing (double) hashes fail in automatic testing, because single hashes are needed there ! first `codeexample` in `pgfmanual-en-xxcolor.tex` isn't extracted (Is this a bug in `extract.lua`? Are there more `codeexamples` elsewhere that are not extracted?) ! second `codeexample` in pgfmanual-en-xxcolor.tex` shows spurious "-6pt-6pt" in the PDF in front of the `minipage` when TeXing the extracted file

- incorporated fixes from main PGF repository (provided by Henri) - changed `\documentclass` from `article` to `standalone` - reordered some stuff - started switching from `libraries/tikz={...}` to `preamble={\usetikzlibrary{...}}`

…kzlibrary{...}}` - continued with following files in the manual

- continued adding code to make extracted `codeexample`s work

(so they can be found more easily)

…unt for the manual files at `/tex/generic/pgf/graphdrawing/lua/pgf/` - accounted for some more `codeexample`s in `doc/generic/pgf/text-en/`

…/lua/pgf/gd`

hmenke

Great effort, but as it stands it still needs a bit of work before it is ready to merge.

doc/generic/pgf/extract.lua

doc/generic/pgf/text-en/pgfmanual-en-base-animations.tex

doc/generic/pgf/text-en/pgfmanual-en-base-patterns.tex

doc/generic/pgf/text-en/pgfmanual-en-dv-axes.tex

doc/generic/pgf/text-en/pgfmanual-en-library-angles.tex

doc/generic/pgf/text-en/pgfmanual-en-tikz-paths.tex

doc/generic/pgf/text-en/pgfmanual-en-tikz-pics.tex

doc/generic/pgf/text-en/pgfmanual-en-xxcolor.tex

tex/generic/pgf/graphdrawing/lua/pgf/gd/control/ComponentAlign.lua

tex/generic/pgf/graphdrawing/lua/pgf/gd/control/ComponentDistance.lua

hmenke · 2019-07-16T22:11:44Z

You should also enable Travis CI for your repository so that the automated checks are run. Right now the manual fails to build. Go to https://travis-ci.com/Mo-Gul/pgf, sign in with GitHub and follow the instructions to enable it.

This reverts commit 2428348, reversing changes made to 09723c9.

- minor stuff

@hmenke

(as @hmenke suggested in #711 (comment))

Mo-Gul · 2019-07-18T21:38:23Z

Thank you for the Travis CI hint. It works fine. But after some more changes (as you can see) now I don't have a clue any more why my Travis CI checks don't succeed. Could you please have a look at them and give me a hint!?

I also want to note that LuaLaTeXing the last commits on my (local) machine works perfectly fine. The last commit results in a 1302 pages PDF and the only "error" I get in my LOG is

Package: infwarerr 2016/05/16 v1.4 Providing info/warning/error messages (HO)

hmenke · 2019-07-18T22:31:47Z

https://travis-ci.com/Mo-Gul/pgf/jobs/217394242#L1952-L1968

[398] [399] [400].../tex/generic/pgf/graphdrawing/lua/pgf/gd/control/doc.lua:28
: attempt to call a nil value
stack traceback:
	.../tex/generic/pgf/graphdrawing/lua/pgf/gd/control/doc.lua:28: in main chunk
	[C]: in function 'require'
	...phdrawing/lua/pgf/gd/interface/InterfaceToAlgorithms.lua:241: in metamethod
 '__index'
	...ul/pgf/tex/generic/pgf/lua/pgf/manual/DocumentParser.lua:386: in field 'ren
derer'
	...ul/pgf/tex/generic/pgf/lua/pgf/manual/DocumentParser.lua:588: in upvalue 'r
ender_infos'
	...ul/pgf/tex/generic/pgf/lua/pgf/manual/DocumentParser.lua:74: in function 'p
gf.manual.DocumentParser.include'
	[\directlua]:1: in main chunk.
\includeluadocumentationof ...Parser.include '#1'}
                                                   
l.181 ...uadocumentationof{pgf.gd.control.Anchoring}

Mo-Gul · 2019-07-19T07:36:10Z

Thank you for that but unfortunately that doesn't help me much. When I look at line in tex/generic/pgf/graphdrawing/lua/pgf/gd/control/doc.lua it just states "documentation" and the following documentation block looks fine for me.

If you know what exactly causes the problem it would be nice if you could state me the solution. If I have to search for the problem myself this would mean that I have to do an unknown number of commits where I comment different parts until I maybe have found it in the Travis CI logs, because -- as I mentioned already -- I do not get any of these errors on my computer ...

tex/generic/pgf/graphdrawing/lua/pgf/gd/trees/doc.lua

tex/generic/pgf/libraries/luamath/pgflibraryluamath.code.tex

tex/generic/pgf/libraries/pgflibrarycurvilinear.code.tex

hmenke

I just noticed that you reverted several bugfixes as part of this PR. This has to be fixed.

hmenke · 2019-07-19T10:45:56Z

Actually you reverted almost all the bugfixes from the 3.1.4 release.

Mo-Gul · 2019-07-19T21:48:01Z

To the last 4 comments:
I am not a Git(Hub) expert and I know that at least at one point I most likely did bullshit. I merged the 'master' into the 'PimpCodeexamples' branch instead of the other way round. But hopefully I could revert that.

And I hopefully did not revert all the bugfixes, but they are just not implemented yet, because I am x commits behind the master ...

If I really should have created a mess it would be great if you could help me. But in principle everything should be fine when only the documentation files can -- later, when I am again through all the files -- accepted in the pull request. Maybe I can even just provide these files in the pull request. We'll see.

Please advice if I can resolve the last two items or do it yourself when everything is fine with that (again), thanks.

Mo-Gul · 2019-07-19T21:51:13Z

One more thing. Providing all the stuff not with setup code and optionally hidden makes it a bit harder. Thus it would be great if I could do a diff of the PDFs before and after my changes. Therefore I need to suppress the output of preamble when TeXing the manual. Could you please state me how I can do this. Many thanks in advance!

hmenke · 2019-07-20T00:29:29Z

Printing of the preamble option is handled here:

pgf/doc/generic/pgf/macros/pgfmanual-en-macros.tex

Lines 1833 to 1837 in f5d0ffd

    
           \ifx\code@preamble\pgfutil@empty\else 
        
             \pgfutil@tempdima=\hsize 
        
             \vbox{\hsize=\pgfutil@tempdima 
        
                 \scriptsize\detokenize\expandafter{\code@preamble}}% 
        
           \fi

- started moving `setup code,hidden` to `preamble` of the `codeexample`s

…iles (of commit 900d477

…e `codeexample`s - minor stuff

Mo-Gul · 2019-07-24T06:57:42Z

- had a look at the `codeexample`s where a leading space was introduced (see #711 (comment)). Some of them could be removed but others are introduced because of code added to the `pre` key where I don't have a clue if/how this can be avoided

…fault) - therefore added loading `graphs` library in `graphs.standard` library - adjusted `preamble` code in `codeexample`s accordingly - there exist `graphdrawing` `codeexample`s in the manual that don't need the `graphs` library --> adjusted `codeexample`s accordingly

hmenke · 2019-08-04T21:38:27Z

You have to fix that botched merge 4dd4ac8 before I can consider this. You reverted all of the fixes of the 3.1.4 release.

doc/generic/pgf/text-en/pgfmanual-en-base-quick.tex

… `pgfmanual-en-base-quick.tex` Co-Authored-By: Henri Menke <henri@icp.uni-stuttgart.de>

Mo-Gul · 2019-08-05T19:36:57Z

As I have commented earlier in commit 2428348 I merged master into PimpCodeexamples, but because this was wrong way round I reverted this with commit 4dd4ac8. My hope was/is that the next merge -- this time the right way round -- will incorporate your fixes (again).

To avoid that I do some more bullshit regarding merges etc., I would appreciate it if you (@hmenke) could do the necessary work. To do so I (hopefully) invited you as collaborator to the fork.

hmenke · 2019-08-20T23:24:42Z

Closed in favour of #729

@hmenke

(as @hmenke suggested in pgf-tikz#711 (comment))

- had a look at the `codeexample`s where a leading space was introduced (see pgf-tikz#711 (comment)). Some of them could be removed but others are introduced because of code added to the `pre` key where I don't have a clue if/how this can be avoided

(related issues pgf-tikz#640, pgf-tikz#711, pgf-tikz#729)

Mo-Gul added 15 commits June 24, 2019 20:58

- commented line that adds all libraries to the extracted codeexample…

b7c5702

…s in `extract.lua` - started adding libraries to the codeexamples

- finished adding libraries to codeexamples of the tutorial doc files

9937193

(so far not all needed styles and definitions were added using `pre` key)

- adapted extract.lua

8ec9894

- incorporated fixes from main PGF repository (provided by Henri) - changed `\documentclass` from `article` to `standalone` - reordered some stuff - started switching from `libraries/tikz={...}` to `preamble={\usetikzlibrary{...}}`

- missed to update pgfmanual-en-macros.tex

bcae73f

- finished switching from libraries/tikz={...} to `preamble={\useti…

125f880

…kzlibrary{...}}` - continued with following files in the manual

- continued adding code to make extracted codeexamples work

cb17274

- continued adding code to make extracted codeexamples work

c39c6a5

- changed order of setup code and preamble in extract.lua

6ef58e6

- continued adding code to make extracted `codeexample`s work

- continued adding code to make extracted codeexamples work

5230356

- % TODOsp: ... --> % TODOsp: codeexamples: ...

f1b8890

(so they can be found more easily)

- removed an unnecessary empty line

da50350

- adapted extract.lua after Henri changed it in Master to also acco…

9da30c6

…unt for the manual files at `/tex/generic/pgf/graphdrawing/lua/pgf/` - accounted for some more `codeexample`s in `doc/generic/pgf/text-en/`

- accounted for some more codeexamples in `tex/generic/graphdrawing…

09723c9

…/lua/pgf/gd`

Merge branch 'master' into PimpCodeexamples

2428348

hmenke requested changes Jul 16, 2019

View reviewed changes

Mo-Gul added 5 commits July 18, 2019 20:03

Revert "Merge branch 'master' into PimpCodeexamples"

4dd4ac8

This reverts commit 2428348, reversing changes made to 09723c9.

- removed commented/unnecessary stuff from extract.lua

30ad80a

- minor stuff

- implemented suggestions given in #711

357a9af

- commented some more \begin{codeexample}[setup code,hidden]

8c51d28

(as @hmenke suggested in #711 (comment))

- also need to Lua comment LaTeX comment in the Lua documentation files

900d477

hmenke reviewed Jul 19, 2019

View reviewed changes

tex/generic/pgf/graphdrawing/lua/pgf/gd/trees/doc.lua Outdated Show resolved Hide resolved

hmenke reviewed Jul 19, 2019

View reviewed changes

tex/generic/pgf/libraries/luamath/pgflibraryluamath.code.tex Show resolved Hide resolved

hmenke reviewed Jul 19, 2019

View reviewed changes

tex/generic/pgf/libraries/pgflibrarycurvilinear.code.tex Show resolved Hide resolved

hmenke requested changes Jul 19, 2019

View reviewed changes

Mo-Gul added 3 commits July 20, 2019 23:48

- moved setup code before pre in extract.lua

ed02c79

- started moving `setup code,hidden` to `preamble` of the `codeexample`s

- corrected wrongly commented Lua comments in the Lua documentation f…

26e55a3

…iles (of commit 900d477

- continued(/finished) moving setup code,hidden to preamble of th…

e66db1b

…e `codeexample`s - minor stuff

Mo-Gul added 3 commits July 24, 2019 23:57

- fixed issue #718 ([manual] \usepgflibrary vs. \usetikzlibrary)

87099dd

Mo-Gul mentioned this pull request Jul 28, 2019

"sub-library" should load "main library" by default #720

Closed

hmenke force-pushed the master branch from 6d4a25c to 0517551 Compare August 3, 2019 08:22

hmenke reviewed Aug 4, 2019

View reviewed changes

doc/generic/pgf/text-en/pgfmanual-en-base-quick.tex Outdated Show resolved Hide resolved

- moved colorlet to the codeexample itself instead of to pre in…

5528f3e

… `pgfmanual-en-base-quick.tex` Co-Authored-By: Henri Menke <henri@icp.uni-stuttgart.de>

Mo-Gul mentioned this pull request Aug 18, 2019

Pimp codeexamples (issue #640) part 2 (of pull request #711) #729

Closed

hmenke closed this Aug 20, 2019

hmenke pushed a commit to hmenke/pgf that referenced this pull request Aug 27, 2019

- implemented suggestions given in pgf-tikz#711

0455591

hmenke pushed a commit to hmenke/pgf that referenced this pull request Aug 27, 2019

- commented some more \begin{codeexample}[setup code,hidden]

592b2cd

(as @hmenke suggested in pgf-tikz#711 (comment))

hmenke pushed a commit to hmenke/pgf that referenced this pull request Aug 27, 2019

- handled one more codeexample that was added after branching.

76a69d2

(related issues pgf-tikz#640, pgf-tikz#711, pgf-tikz#729)

Mo-Gul deleted the PimpCodeexamples branch September 8, 2019 16:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pimp codeexamples (issue #640) #711

Pimp codeexamples (issue #640) #711

Mo-Gul commented Jul 16, 2019

hmenke left a comment

hmenke commented Jul 16, 2019

Mo-Gul commented Jul 18, 2019 •

edited

Loading

hmenke commented Jul 18, 2019

Mo-Gul commented Jul 19, 2019

hmenke left a comment

hmenke commented Jul 19, 2019

Mo-Gul commented Jul 19, 2019

Mo-Gul commented Jul 19, 2019 •

edited

Loading

hmenke commented Jul 20, 2019

Mo-Gul commented Jul 24, 2019 •

edited

Loading

hmenke commented Aug 4, 2019

Mo-Gul commented Aug 5, 2019

hmenke commented Aug 20, 2019

Pimp codeexamples (issue #640) #711

Pimp codeexamples (issue #640) #711

Conversation

Mo-Gul commented Jul 16, 2019

hmenke left a comment

Choose a reason for hiding this comment

hmenke commented Jul 16, 2019

Mo-Gul commented Jul 18, 2019 • edited Loading

hmenke commented Jul 18, 2019

Mo-Gul commented Jul 19, 2019

hmenke left a comment

Choose a reason for hiding this comment

hmenke commented Jul 19, 2019

Mo-Gul commented Jul 19, 2019

Mo-Gul commented Jul 19, 2019 • edited Loading

hmenke commented Jul 20, 2019

Mo-Gul commented Jul 24, 2019 • edited Loading

hmenke commented Aug 4, 2019

Mo-Gul commented Aug 5, 2019

hmenke commented Aug 20, 2019

Mo-Gul commented Jul 18, 2019 •

edited

Loading

Mo-Gul commented Jul 19, 2019 •

edited

Loading

Mo-Gul commented Jul 24, 2019 •

edited

Loading