Codify figures for Part 2

[LinqLover]

Workflow

The underlying build process has been reworked. It might be useful to take a look at the PR description of #20.

1. Choose a figure from the list below you like
2. Add your name to the item (for example, (ct))
   • If the figure cannot be automated, strike it through
3. Open the depending tex file and insert the following snipped before the \figure definition:

\begin{ExecuteSmalltalkScript}
SBESqueakPicture writeTo: './figures/*FILENAME*.png' frame: #morphs using: [:helper |
   self shouldBeImplemented
]
\end{ExecuteSmalltalkScript}

4. Fill in the template
5. Test your script by doing SBEFigureBuilder buildAllTexFigures (maybe you need to set #resourceDirectory before) or SBEFigureBuilder buildFiguresWith: FSPath * 'your' / 'path'
6. Remove all generated PNGs - once a figure is automated, we do not want to leave the generated PNG in the repo
7. Commit! 🚀
8. If the Travis build passes and the generated PDF looks well, check the item off

[LinqLover]

The figures

powershell $dir -Directory | Group-Object $_.Name | % { echo "## $($_.Name)" ; $_.Group | %{Get-ChildItem -Path $_.Name -Filter *.png -r} | %{"- [ ] $($_.Name)" } }

figures ✔️

• blackHandle.png (ct)
• CreativeCommons-BY-SA.png
• debugHandle.png (ct)
• moveHandle.png (ct)
• sq.png
• squeak-logo.png

4. Messages ✔️

(no screenshots at all)

5. Model

• Color-Buttons.png (ct) [Should we renew the diagram (this might impact the layout) or keep the figure as-is? I cannot edit the graffle file.]
• fooNotFound.png (ct) [Graffle issue, see above]
• initStringLookup.png
• openInWorldLookup.png
• privateSharedVarColor.png

6. Environment

• CanvasDraw.png (ct)
• changeSetBrowser.png (ct)
• changeSorter.png (ct)
• debuggerDetectIfNone.pngdebuggerDetect.png (ct)
• debugHandle.png (merged with ../figures)
• dotIsAString.png (ct)
• explorePluggableListMorph.png (ct)
• exploreTimeStampNow.png (ct)
• exploreTimeStampNow2.png (ct) [discussion here]
• fileContentsBrowser.png (ct)
• fileList.png (ct)
• fixOffByOne.png (ct)
• freshMonticello.png (ct)
• HaloOnPluggableList.png (ct: no senders)
• hierarchyBrowser.png (ct)
• inheritanceOverriding.png (ct)
• inspectTimeNow1.png (ct)
• MC+SBE.png (ct)
• MCaddToPackage.png (ct) [bug in event simulation: ActiveEvent is not set]
• MCnewcategory.png (ct)
• MCnewmethod.png (ct)
• methodNamesRandom.png (ct)
• OBInheritanceOverriding.png (ct) [discussion below]
• package-cache-browser.png (ct) [SBE package is missing in this window]
• PreDebugWindow.png (ct)
• processBrowser.png (ct)
• RestartDetectIfNone.pngRestartDetect.png (ct)
• revertDialog.png (ct)
• SBE-apb.png (ct) [How to change version message text? Sporadic nils in TextMorph!]
• SendersOfCheckEvent.png (ct)
• SqueakSource-SBE.png (ct)
• steppingIntoValue.png (ct)
• SystemBrowser0.png (ct)
• SystemBrowser1.png (ct)
• SystemBrowserClassCreation.png (ct)
• SystemBrowserMethodTemplate.png (ct)
• SystemBrowserMyDependents.png (ct)
• VersionsOfMouseUp.png (ct)

7. SUnit ✔️

• sunit-classes.png
• sunit-scenario.png
• test-runner.png (ct)

8. BasicClasses ✔️

• BooleanHierarchy.png
• NumberHierarchy.png
• StringHierarchy.png

9. Collections ✔️

• CollectionHierarchy.png
• CollectionHierarchyList.png
• CollectionsByImpl.png
• CollectionsBySeq.png

10. Streams ✔️

• abcde_.png
• ab_cde.png
• ab_cdeStef.png
• ax_cde.png
• ax_cdeStef.png
• a_bcde.png
• a_bcdeStef.png
• checkerboard4x4.png (ct)
• emptyStef.png
• emptyStream.png
• page1.png
• page1Stef.png
• page1_.png
• page1_Stef.png
• page2.png
• page2Stef.png
• page2_.png
• page2_Stef.png
• page3.png
• page3Stef.png
• page4.png
• page4Stef.png
• page4_Stef.png
• _abcde.png
• _abcdeStef.png

11. Morphic

• cross.png (no senders)
• detachingMenu.png (ct)
• dialog.png (ct)
• die.png (ct)
• hairlineBug.png (ct)
• joeStar.png (ct)
• labeler.png (currently not in use)
• multiMorphs.png (ct)
• NewCross.png (ct)
• overdrawBug.png (ct)
• popup.png (ct) [see UIManager discussion below]
• pyramid.png (currently not in use)

12. Metaclasses

• InspectingColor.png (ct)
• TranslucentBehavior.png
• TranslucentClassMessage.png
• TranslucentColorBlue.png
• TranslucentEllipse.png (ct)
• TranslucentMetaclassClass.png
• TranslucentMetaclassClassClass.png
• TranslucentMetaclasses.png
• TranslucentMetaclassHierarchy.png
• TranslucentSendingNew.png

Syntax (Is this used anywhere?)

• rotated.png

[LinqLover]

@codeZeilen Figure 6.10 shows an OmniBrowser:

According to Swiki, the OmniBrowser is no longer supported. Shall we remove this one and the related passage from Environment.tex?

[codeZeilen]

@LinqLover This figure should be replaced by a normal InheritanceBrowser. This figure is actually relevant. for the paragraph "Method overridings"

[LinqLover]

@codeZeilen Wouldn't this be a duplication of Figure 6.9? The depending passage is

Note that there are currently two versions of the inheritance browser. If youareusingtheversionofthesystembrowserbasedontheOmniBrowser framework, the inheritance button does not change colour, and the inheritance browser looks different. It also displays more information: it shows not only the methods on the inheritance chain, but also their siblings. This version of the inheritance browser is shown in Figure 6.10.

[codeZeilen]

Ah didnt see that. Yes this can go. :) Am Di., 5. Nov. 2019 um 20:03 Uhr schrieb Christoph Thiede < notifications@github.com>:

…

@codeZeilen <https://github.com/codeZeilen> Wouldn't this be a duplication of Figure 6.9? The depending passage is Note that there are currently two versions of the inheritance browser. If youareusingtheversionofthesystembrowserbasedontheOmniBrowser framework, the inheritance button does not change colour, and the inheritance browser looks different. It also displays more information: it shows not only the methods on the inheritance chain, but also their siblings. This version of the inheritance browser is shown in Figure 6.10. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#21>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEI3YB7HCLD5OTBUX7EZA3QSG7RNANCNFSM4JIFOSUA> .

[LinqLover]

One question concerning the text belonging to figure Environment/MC+SBE: It currently says:

To tell Monticello about your package, click on +Package, and type the name of the package, in his case "SBE". Monticello will add SBE to its list of packages; the package entry will be marked with an asterisk to show that the version in the image has not yet been written to any repository. [italic mine]

I cannot reproduce this (using another fresh repo name, of course): The new package is not detected as modified until the next SystemChangeNotifier event is raised. Is this a regression in Trunk or should we update the section in the book?

[LinqLover]

One question concerning the text belonging to figure Environment/MC+SBE: It currently says:

To tell Monticello about your package, click on +Package, and type the name of the package, in his case "SBE". Monticello will add SBE to its list of packages; the package entry will be marked with an asterisk to show that the version in the image has not yet been written to any repository. [italic mine]

I cannot reproduce this (using another fresh repo name, of course): The new package is not detected as modified until the next SystemChangeNotifier event is raised. Is this a regression in Trunk or should we update the section in the book?

@codeZeilen? :-)

[LinqLover]

@codeZeilen Would you like figure 6.24 (debuggerDetect) to show the method #detect:ifFound:ifAbsent: (as the original version looked like) or rather the method #errorNotFound: (what, in my opinion, would better match the description)?

[LinqLover]

@codeZeilen Should method snippets 6.{2,3} be updated to use #assert:equals: rather than calling #=?

testSuffixFound
	self assert: 'readme.txt' suffix = 'txt'

[LinqLover]

The chapters "QuickTour" and "Environment" describe changes to the existing class StringTest. In our SmalltalkSources, these changes are partly absent (#testShout), partially put into the class StringSuffixTest.

I think we should unify this - either put all these methods as an extension method into StringTest, or add a paragraph into the book that describes how the class SBEStringTest is created. Opinions?

[codeZeilen]

One question concerning the text belonging to figure Environment/MC+SBE: It currently says:

To tell Monticello about your package, click on +Package, and type the name of the package, in his case "SBE". Monticello will add SBE to its list of packages; the package entry will be marked with an asterisk to show that the version in the image has not yet been written to any repository. [italic mine]

I cannot reproduce this (using another fresh repo name, of course): The new package is not detected as modified until the next SystemChangeNotifier event is raised. Is this a regression in Trunk or should we update the section in the book?

@codeZeilen? :-)

Difficult to decide... I would guess regression.

[codeZeilen]

errorNotFound

If that matches the description better, go for it.

[codeZeilen]

@codeZeilen Should method snippets 6.{2,3} be updated to use #assert:equals: rather than calling #=?

testSuffixFound
	self assert: 'readme.txt' suffix = 'txt'

Yes, but check the text first whether custom assertions are explained later on somewhere