Updating 'Squeak by Example'

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
13 messages Options
Reply | Threaded
Open this post in threaded view
|

Updating 'Squeak by Example'

timrowledge
At the squeak board meeting on Weds we discussed updating the 'Squeak by Example' book in order to have working examples and current screenshots etc. It's a good book in general and would be a useful thing to point new squeakers to with some updating.

The sources are at https://github.com/SquareBracketAssociates/SqueakByExample-english (and there are some translations too) and I see some recent changes by Patrick R (thanks!) mentioned in my email. Personally I'd appreciate some advice on what program one might use to edit the stuff. I don't think I can manage LaTEX.

tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful Latin Phrases:- Visne saltare? Viam Latam Fungosam scio = Do you want to dance? I know the Funky Broadway.



Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Tobias Pape

> On 08.11.2019, at 20:12, tim Rowledge <[hidden email]> wrote:
>
> At the squeak board meeting on Weds we discussed updating the 'Squeak by Example' book in order to have working examples and current screenshots etc. It's a good book in general and would be a useful thing to point new squeakers to with some updating.
>
> The sources are at https://github.com/SquareBracketAssociates/SqueakByExample-english (and there are some translations too) and I see some recent changes by Patrick R (thanks!) mentioned in my email. Personally I'd appreciate some advice on what program one might use to edit the stuff. I don't think I can manage LaTEX.

Don't worry about that last part…
-t

>
> tim




Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Christoph Thiede
In reply to this post by timrowledge

Hi tim,


we (that means, mainly Patrick) are currently working on updating all contents and screenshots of the book to match the latest Squeak version. By the way, we are taking this opportunity to codify each screenshots with a short script in the tex source, so they will not deprecate so fast again (until someone reworks the whole UI) :D


What are your tool questions about in detail? We completely automated the build process, so in general, you can simply fork the repo and change the tex source, and TravisCI will generate a new PDF for you whenever you push (which is deployed as GitHub release and/or an upload to Google Drive). If you would like to build it locally, you will need: a tex editor (recommended - in general, you can do this from vim or notepad as well. Personally, I am using VS Code), make, texlive, and Squeak. For the complete build process, please have a look at .travis.yml and Makefile. The build process basically looks like this:


  1. Load the SmalltalkSources into Squeak (they require Trunk)
  2. Do it: SBEFigureBuilder buildAllTexFigures
    This will parse all SmalltalkInTex scripts and generate figures of it into the build directory.
  3. From shell: run make
    This will:
    • Generate listings from the SmalltalkSources
    • Run texlive to generate bibliography & pdf


I know I finally need to document this process. :) If you have further questions, we're there on GitHub Issues or here.


Best,

Christoph



Von: Squeak-dev <[hidden email]> im Auftrag von tim Rowledge <[hidden email]>
Gesendet: Freitag, 8. November 2019 20:12 Uhr
An: The general-purpose Squeak developers list
Betreff: [squeak-dev] Updating 'Squeak by Example'
 
At the squeak board meeting on Weds we discussed updating the 'Squeak by Example' book in order to have working examples and current screenshots etc. It's a good book in general and would be a useful thing to point new squeakers to with some updating.

The sources are at https://github.com/SquareBracketAssociates/SqueakByExample-english (and there are some translations too) and I see some recent changes by Patrick R (thanks!) mentioned in my email. Personally I'd appreciate some advice on what program one might use to edit the stuff. I don't think I can manage LaTEX.

tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful Latin Phrases:- Visne saltare? Viam Latam Fungosam scio = Do you want to dance? I know the Funky Broadway.





Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

timrowledge


> On 2019-11-08, at 11:38 AM, Thiede, Christoph <[hidden email]> wrote:
>
> Hi tim,
>
> we (that means, mainly Patrick) are currently working on updating all contents and screenshots of the book to match the latest Squeak version. By the way, we are taking this opportunity to codify each screenshots with a short script in the tex source, so they will not deprecate so fast again (until someone reworks the whole UI) :D

Excellent. And thank you!

>
> What are your tool questions about in detail?

Having never - to the best of my knowledge - used anything that edits LaTEX, I am ignorant of what tool I might use to make any attempt at helping. What editors (Mac, obviously) are capable of editing such a document in any form other than the 'good grief what is this stuff' plain text?


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful random insult:- Couldn't find his way through a maze even if the rats helped him.



Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Nicolas Cellier
Latex (tex) is plain text contents intermixed with plain text formatting commands...
So use whatever text editor...

Le ven. 8 nov. 2019 à 21:02, tim Rowledge <[hidden email]> a écrit :


> On 2019-11-08, at 11:38 AM, Thiede, Christoph <[hidden email]> wrote:
>
> Hi tim,
>
> we (that means, mainly Patrick) are currently working on updating all contents and screenshots of the book to match the latest Squeak version. By the way, we are taking this opportunity to codify each screenshots with a short script in the tex source, so they will not deprecate so fast again (until someone reworks the whole UI) :D

Excellent. And thank you!

>
> What are your tool questions about in detail?

Having never - to the best of my knowledge - used anything that edits LaTEX, I am ignorant of what tool I might use to make any attempt at helping. What editors (Mac, obviously) are capable of editing such a document in any form other than the 'good grief what is this stuff' plain text?


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful random insult:- Couldn't find his way through a maze even if the rats helped him.





Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

timrowledge


> On 2019-11-08, at 12:24 PM, Nicolas Cellier <[hidden email]> wrote:
>
> Latex (tex) is plain text contents intermixed with plain text formatting commands...
> So use whatever text editor...

That sounds unpleasantly like raw-editing PDF. eek.


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Oxymorons: Political science



Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Nicolas Cellier
Not at all.
Formatting command are higher level
(open a new chapter etc...).

Latex does all the composition for you.

Le ven. 8 nov. 2019 à 21:26, tim Rowledge <[hidden email]> a écrit :


> On 2019-11-08, at 12:24 PM, Nicolas Cellier <[hidden email]> wrote:
>
> Latex (tex) is plain text contents intermixed with plain text formatting commands...
> So use whatever text editor...

That sounds unpleasantly like raw-editing PDF. eek.


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Oxymorons: Political science





Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Christoph Thiede

It would be harder if you wanted to change the whole layout, but adding content only is quite simple:



That reads quite intuitive, doesn't it?

But I would recommend you to use an editor with appropriate syntax highlighting. VS Code is one of many editors that support LaTeX ...


(Why doesn't Shout support LaTeX yet? :))


Von: Squeak-dev <[hidden email]> im Auftrag von Nicolas Cellier <[hidden email]>
Gesendet: Freitag, 8. November 2019 21:30:37
An: The general-purpose Squeak developers list
Betreff: Re: [squeak-dev] Updating 'Squeak by Example'
 
Not at all.
Formatting command are higher level
(open a new chapter etc...).

Latex does all the composition for you.

Le ven. 8 nov. 2019 à 21:26, tim Rowledge <[hidden email]> a écrit :


> On 2019-11-08, at 12:24 PM, Nicolas Cellier <[hidden email]> wrote:
>
> Latex (tex) is plain text contents intermixed with plain text formatting commands...
> So use whatever text editor...

That sounds unpleasantly like raw-editing PDF. eek.


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Oxymorons: Political science






pastedImage.png (93K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Squeak - Dev mailing list
In reply to this post by timrowledge
On MacOS Mojave, fire up homebrew and it tells you:

There are three versions of MacTeX.


Full installation:

  brew cask install mactex


Full installation without bundled applications:

  brew cask install mactex-no-gui


Minimal installation:

  brew cask install basictex


This probably the easiest way to get into Tex, IMHO.


On November 8, 2019 at 1:02 PM, tim Rowledge <[hidden email]> wrote:



On 2019-11-08, at 11:38 AM, Thiede, Christoph <[hidden email]> wrote:

Hi tim,

we (that means, mainly Patrick) are currently working on updating all contents and screenshots of the book to match the latest Squeak version. By the way, we are taking this opportunity to codify each screenshots with a short script in the tex source, so they will not deprecate so fast again (until someone reworks the whole UI) :D

Excellent. And thank you!


What are your tool questions about in detail?

Having never - to the best of my knowledge - used anything that edits LaTEX, I am ignorant of what tool I might use to make any attempt at helping. What editors (Mac, obviously) are capable of editing such a document in any form other than the 'good grief what is this stuff' plain text?


tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful random insult:- Couldn't find his way through a maze even if the rats helped him.





Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

K K Subbu
In reply to this post by timrowledge
On 09/11/19 1:32 AM, tim Rowledge wrote:
> Having never - to the best of my knowledge - used anything that edits
> LaTEX, I am ignorant of what tool I might use to make any attempt at
> helping. What editors (Mac, obviously) are capable of editing such a
> document in any form other than the 'good grief what is this stuff'
> plain text?

There are a whole bunch of GUI editors for TeX on MAC:

  TeXMaker, TeXstudio, LyX, MacTeX, TeXShop, MikTeX, ...

The TeX User Group (http://tug.org/begin.html) has a FAQ on MAC at
https://texfaq.org/FAQ-sysmac

vim also has a latex-suite to ease editing TeX.

HTH .. Subbu

Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Christoph Thiede
In reply to this post by Christoph Thiede
Just to clarify: Most of these changes are in [hidden email] fork.

Best, Christoph



On Fri, Nov 8, 2019 at 8:38 PM +0100, "Thiede, Christoph" <[hidden email]> wrote:

Hi tim,


we (that means, mainly Patrick) are currently working on updating all contents and screenshots of the book to match the latest Squeak version. By the way, we are taking this opportunity to codify each screenshots with a short script in the tex source, so they will not deprecate so fast again (until someone reworks the whole UI) :D


What are your tool questions about in detail? We completely automated the build process, so in general, you can simply fork the repo and change the tex source, and TravisCI will generate a new PDF for you whenever you push (which is deployed as GitHub release and/or an upload to Google Drive). If you would like to build it locally, you will need: a tex editor (recommended - in general, you can do this from vim or notepad as well. Personally, I am using VS Code), make, texlive, and Squeak. For the complete build process, please have a look at .travis.yml and Makefile. The build process basically looks like this:


  1. Load the SmalltalkSources into Squeak (they require Trunk)
  2. Do it: SBEFigureBuilder buildAllTexFigures
    This will parse all SmalltalkInTex scripts and generate figures of it into the build directory.
  3. From shell: run make
    This will:
    • Generate listings from the SmalltalkSources
    • Run texlive to generate bibliography & pdf


I know I finally need to document this process. :) If you have further questions, we're there on GitHub Issues or here.


Best,

Christoph



Von: Squeak-dev <[hidden email]> im Auftrag von tim Rowledge <[hidden email]>
Gesendet: Freitag, 8. November 2019 20:12 Uhr
An: The general-purpose Squeak developers list
Betreff: [squeak-dev] Updating 'Squeak by Example'
 
At the squeak board meeting on Weds we discussed updating the 'Squeak by Example' book in order to have working examples and current screenshots etc. It's a good book in general and would be a useful thing to point new squeakers to with some updating.

The sources are at https://github.com/SquareBracketAssociates/SqueakByExample-english (and there are some translations too) and I see some recent changes by Patrick R (thanks!) mentioned in my email. Personally I'd appreciate some advice on what program one might use to edit the stuff. I don't think I can manage LaTEX.

tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful Latin Phrases:- Visne saltare? Viam Latam Fungosam scio = Do you want to dance? I know the Funky Broadway.





Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

K K Subbu
In reply to this post by Christoph Thiede
On 09/11/19 1:08 AM, Thiede, Christoph wrote:
>
> we (that means, mainly Patrick) are currently working on updating
> all contents and screenshots of the book to match the latest Squeak
> version. By the way, we are taking this opportunity to codify each
> screenshots with a short script in the tex source, so they will not
> deprecate so fast again (until someone reworks the whole UI) :D
>
Chris,

Have you looked at HelpTopic? It would be nice to document Squeak in
HelpTopic first and then export it to other formats like LaTeX to
produce a book. Something like Quick Guides [1] of Etoys.

It is easier to keep such topics in sync with releases while a book
tends to fall behind over the years and has to be refreshed. Also, code
snippets can be run from the topic itself without having to copy-paste
into a Workspace.

[1] http://www.squeakland.org/tutorials/guides/

Regards .. Subbu

Reply | Threaded
Open this post in threaded view
|

Re: Updating 'Squeak by Example'

Christoph Thiede
In reply to this post by Christoph Thiede
The mail server has managed to hide the GitHub name, so here it is again:

https://github.com/codeZeilen/SqueakByExample-english



--
Sent from: http://forum.world.st/Squeak-Dev-f45488.html