[squeak-dev] The Trunk: Help-Squeak-Project-ct.96.mczcommits at source.squeak.org commits at source.squeak.orgTue Sep 27 09:33:18 UTC 2022
Christoph Thiede uploaded a new version of Help-Squeak-Project to project The Trunk: http://source.squeak.org/trunk/Help-Squeak-Project-ct.96.mcz ==================== Summary ==================== Name: Help-Squeak-Project-ct.96 Author: ct Time: 27 September 2022, 11:33:17.408156 am UUID: 1a0702c7-7a57-894a-9e75-e62599ca7b9b Ancestors: Help-Squeak-Project-ct.95, Help-Squeak-Project-ct.94 Adds help on how to contribute to Squeak. Short description of the community model, the development process, and some required/recommended tools. Reformats the page 'Squeak Resources Online' and adds a link to the new tutorial. Reorders project pages. Adds a very simple way to include figures to the new help book. Revised version. Thanks to Robert (rhi), Jakob (jr), Tim (tpr), and Jaromir (jar) for their reviews and edits! =============== Diff against Help-Squeak-Project-ct.95 =============== Item was added: + SqueakProjectHelp subclass: #SqueakContributionHelp + instanceVariableNames: '' + classVariableNames: '' + poolDictionaries: '' + category: 'Help-Squeak-Project'! Item was added: + ----- Method: SqueakContributionHelp class>>advanced (in category 'pages') ----- + advanced + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #advanced" + <generated> + ^(HelpTopic + title: 'Advanced' + contents: + 'Advanced Concepts + + Change sets: Usually, new proposals are best submitted to the inbox as a new package version. However, when some ideas consist of changes to multiple packages, it becomes tricky to work with multiple versions from the inbox. In this case, a change set is a good alternative. Change sets are collections of methods and class definitions, plus some extras. You can open a dual change sorter from the Tools and Changes menus in the docking bar and open a menu on the change set list on the left. Create a new change set and copy or move all relevant changes to it. Add a preamble to the change set to add an explaining message and finally file out or mail to list it directly. To install a change set, you can file in it from the file list, or you can drag and drop it into Squeak from the outside. + + Preambles and postscripts: Some changes make it necessary to run some scripts before or after loading the new code to perform any migrations or changes to the global object graph. This is possible through preambles and postscripts. To add or edit a script for a Monticello package, select it in the Monticello browser and press the Scripts button. Add your logic to the code, test it, save it, and include it in your next inbox version. Note that preambles and postscripts in Trunk packages are required to be idempotent and may be evaluated multiple times. For change sets, you can add a preamble and a postscript as well from the context menu of the change set list in the change sorter. + + --- + If you identify any other contribution-related concepts that should be mentioned or explained in greater detail here, please feel free to add them here. This could even be your first contribution!!!! :-)!! + ]style[(17 2 12 263 80 15 18 10 5 5 7 78 23 5 4 4 4 29 14 60 8 4 12 47 7 13 9 1 60 26 273 18 15 7 556)a0b,a0,a0b,a0,,a0,a0i,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Dual Change Sorter'';,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | (m respondsTo: #wordingSelector) and: [m wordingSelector = #browseChangesLabel]] + filterItem: ''Dual Change Sorter'';,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,a0i,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''File List'';,,a0,a0b,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Monticello Browser'';,a0,a0i,a0!!' readStream nextChunkText) + key: #advanced; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>bookBlurb (in category 'accessing') ----- + bookBlurb + + self flag: #moveUpstream. + ^ (self perform: self defaultPage) contents! Item was added: + ----- Method: SqueakContributionHelp class>>bookName (in category 'accessing') ----- + bookName + + ^ 'Contributing to Squeak'! Item was added: + ----- Method: SqueakContributionHelp class>>communityModel (in category 'pages') ----- (excessive size, no diff calculated) Item was added: + ----- Method: SqueakContributionHelp class>>contributingToSqueak (in category 'pages') ----- + contributingToSqueak + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #contributingToSqueak" + <generated> + ^(HelpTopic + title: 'Contributing' + contents: + 'Contributing to Squeak + + Squeak is a highly open system, which makes it very easy not only to explore every interesting detail in the image but also to customize everything at your will. Whether you would like to adjust some colors, fix a bug you have stumbled upon, or add a new feature, (almost) everything is flexible and under your control. + + Squeak lives from your contributions!!!! Squeak is powered by volunteer open-source contributions. Whenever you make an adjustment to the base system, you might ask yourself: "could others benefit from this change, too?". If the answer is yes, we invite you to consider contributing back to the community. Or if you just discovered a bug, have a question, or would like to discuss an idea, our forums are open!!!!!! + ]style[(24 12 18 158 18 8 3 28 17 59 37 136 43 191)a0b,a0,a0i,a0,Rcode:// SqueakTheme class>>#addSyntaxHighlighting:;,a0,Rcode:// + self systemNavigation browseAllImplementorsOf: #expectedFailures;,a0,,a0,a0i,a0,a0i,a0!!' readStream nextChunkText) + key: #contributingToSqueak; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>defaultPage (in category 'accessing') ----- + defaultPage + + ^ #contributingToSqueak! Item was added: + ----- Method: SqueakContributionHelp class>>firstContribution (in category 'pages') ----- + firstContribution + "This method was automatically generated. Edit it using:" + "SqueakContributionHelp edit: #firstContribution" + <generated> + ^(HelpTopic + title: 'First Contribution' + contents: + 'Making Your First Contribution + + * Install the latest Trunk updates. + * Make your change, preferably starting from a clean image (to avoid configuration drift). + * Open the Monticello Browser: + * On the left, select the package you have changed (changed packages are marked with an *asterisk). + * On the right, select the inbox repository. + * On the top, press save. + * Review your changes, enter a meaningful version message that explains what the changes are for (e.g., which bug they address, what they are aimed at improving), and accept the new version to upload it. + * That''s it!!!! Your contribution has arrived in the Inbox and soon you will receive feedback from the community through the mailing list. Keep an eye on your mailbox!!!!!! + ]style[(30 4 33 94 27 5 12 12 7 19 27 9 9 6 13 12 5 34 5 59 103 6 6 33 10 152)a0b,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | (m owner submorphIndexOf: m) = 1] + filterItem: ''Update'';,a0,Rcode:// + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = ''Tools''] + filterItem: ''Monticello Browser'';,,a0b,a0,a0b,a0,,a0,a0i,a0,a0b,a0,a0b,a0,a0b,a0,,a0,a0b,a0,a0i,a0!!' readStream nextChunkText) + key: #firstContribution; + shouldStyle: false; + yourself! Item was added: + ----- Method: SqueakContributionHelp class>>openDockingBarMenuThat:filterItem: (in category 'support') ----- + openDockingBarMenuThat: menuBlock filterItem: filterString + "Example: + SqueakContributionHelp + openDockingBarMenuThat: [:m | m contents = 'Tools'] + filterItem: 'Squeak Inbox Talk' + Don't delete, this has indeed senders in some TextURL attributes within the pages of this help. + " + + | dockingBar menu | + dockingBar := (self currentWorld mainDockingBars ifEmpty: [^ self]) first. + menu := (dockingBar submorphs select: #isMenuItemMorph) detect: menuBlock ifNone: [^ self]. + dockingBar selectItem: menu event: self currentEvent. + menu subMenu setProperty: #matchString toValue: filterString. + menu subMenu displayFiltered: self currentEvent. + ^ nil "do not answer a Behavior here, which would trigger another browser when sending this message from a TextURL"! Item was added: + ----- Method: SqueakContributionHelp class>>pages (in category 'accessing') ----- + pages + + ^ #(contributingToSqueak communityModel firstContribution squeakInboxTalk advanced)! Item was added: + ----- Method: SqueakContributionHelp class>>squeakInboxTalk (in category 'pages') ----- (excessive size, no diff calculated) Item was added: + TextAnchor subclass: #SqueakHelpTextImage + instanceVariableNames: '' + classVariableNames: '' + poolDictionaries: '' + category: 'Help-Squeak-Project'! Item was added: + ----- Method: SqueakHelpTextImage class>>forForm: (in category 'instance creation') ----- + forForm: aForm + + ^ self new + form: aForm; + yourself! Item was added: + ----- Method: SqueakHelpTextImage class>>scanCharacter (in category 'fileIn/Out') ----- + scanCharacter + + ^ $m! Item was added: + ----- Method: SqueakHelpTextImage class>>scanFrom: (in category 'fileIn/Out') ----- + scanFrom: aStream + + | base64 data form | + base64 := aStream upTo: $;. + data := Base64MimeConverter mimeDecodeToBytes: base64 readStream. + form := ImageReadWriter formFromStream: data. + ^ self forForm: form! Item was added: + ----- Method: SqueakHelpTextImage>>exportBase64 (in category 'fileIn/fileOut') ----- + exportBase64 + + ^ (ByteArray streamContents: [:stream | + PNGReadWriter putForm: self form onStream: stream]) + base64Encoded + ! Item was added: + ----- Method: SqueakHelpTextImage>>form (in category 'accessing') ----- + form + + ^ self anchoredMorph image! Item was added: + ----- Method: SqueakHelpTextImage>>form: (in category 'accessing') ----- + form: aForm + + self anchoredMorph: aForm asMorph.! Item was added: + ----- Method: SqueakHelpTextImage>>writeScanOn: (in category 'fileIn/fileOut') ----- + writeScanOn: aStream + + aStream + nextPut: self class scanCharacter; + nextPutAll: self exportBase64; + nextPut: $;.! Item was changed: ----- Method: SqueakProjectHelp class>>pages (in category 'accessing') ----- pages + ^#(workingWithSqueak squeakUserInterface extendingTheSystem squeakResourcesOnline)! - ^#(extendingTheSystem squeakResourcesOnline squeakUserInterface workingWithSqueak)! Item was changed: ----- Method: SqueakProjectHelp class>>squeakResourcesOnline (in category 'pages') ----- squeakResourcesOnline "This method was automatically generated. Edit it using:" "SqueakProjectHelp edit: #squeakResourcesOnline" <generated> ^(HelpTopic title: 'Squeak Resources Online' contents: 'Web sites Main site of Squeak + https://www.squeak.org - https://www.squeak.org Issue Tracker for bug reports and other feedback + https://bugs.squeak.org - https://bugs.squeak.org Weekly Squeak + https://news.squeak.org - https://news.squeak.org Downloads for many versions + https://www.squeak.org/downloads - https://www.squeak.org/downloads Main site of OpenSmalltalk VM + https://github.com/OpenSmalltalk/opensmalltalk-vm - https://github.com/OpenSmalltalk/opensmalltalk-vm Mailing lists beginners + This is the place to ask even the most basic questions. Don''t be afraid. Just ask. The community will help you get started with Squeak. + https://lists.squeakfoundation.org/mailman/listinfo/beginners - This is the place to ask even the most basic questions. Don''t be afraid. Just ask. The community will help you get started with Squeak. - https://lists.squeakfoundation.org/mailman/listinfo/beginners squeak-dev + This is the main Squeak mailing list. Join that list to be part in the community. Subscribe to the mail server or read on a forum. + https://lists.squeakfoundation.org/mailman/listinfo/squeak-dev + For more information on the community and the contribution process, check out the tutorial Contributing to Squeak in the following pages. - This is the main Squeak mailing list. Join that list to be part in the community. Subscribe to the mail server or read on a forum. - https://lists.squeakfoundation.org/mailman/listinfo/squeak-dev vm-beginners + This is the entry point for people who want to learn more about how Squeak runs on your operating system. You may ask even basic questions. :-) + https://lists.squeakfoundation.org/mailman/listinfo/vm-beginners - This is the entry point for people who want to learn more about how Squeak runs on your operating system. You may ask even basic questions. :-) - https://lists.squeakfoundation.org/mailman/listinfo/vm-beginners vm-dev + This is the place where discussions about the OpenSmalltalk virtual machine happen. Join that list the be a part of the community. + https://lists.squeakfoundation.org/mailman/listinfo/vm-dev - This is the place where discussions about the OpenSmalltalk virtual machine happen. Join that list the be a part of the community. - https://lists.squeakfoundation.org/mailman/listinfo/vm-dev Books Squeak By Example + A beginners textbook, currently based on Squeak 5.3 and so a little out of date in some visual aspects and some details. Still a valuable resource. The content is maintained in GitHub at + https://github.com/hpi-swa-lab/SqueakByExample-english - A beginners textbook, currently based on Squeak 5.3 and so a little out of date in some visual aspects and some details. Still a valuable resource. The content is maintained in github at - https://github.com/hpi-swa-lab/SqueakByExample-english but a prepared and ready to read pdf version can be found at + https://github.com/hpi-swa-lab/SqueakByExample-english/releases - https://github.com/hpi-swa-lab/SqueakByExample-english/releases Other books + Many books about Squeak and Smalltalk in general have been made available: + https://squeak.org/documentation/#books!! + ]style[(11 19 1 23 48 1 23 1 14 23 1 27 1 32 1 29 1 49 1 1 13 1 1 10 135 1 61 1 1 10 1 131 62 92 22 25 1 13 144 64 1 1 6 1 131 58 1 1 5 2 17 1 187 54 62 63 1 1 11 1 75 39)b,I0i,I0,Rhttps://www.squeak.org;I1,I0i,I0,Rhttps://bugs.squeak.org;I1,I1,I0i,Rhttps://news.squeak.org;I1,I1,I0i,I0,Rhttps://www.squeak.org/downloads;I1,I1,I0i,I0,Rhttps://github.com/OpenSmalltalk/opensmalltalk-vm;I1,I1,I0,I0b,I0,,i,I1,bI1,Rhttps://lists.squeakfoundation.org/mailman/listinfo/beginners;I1,I1,,i,b,I1,Rhttps://lists.squeakfoundation.org/mailman/listinfo/squeak-dev;I1,I1,I1b,I1,,i,I1,Rhttps://lists.squeakfoundation.org/mailman/listinfo/vm-beginners;I1,I1,,i,,I1,Rhttps://lists.squeakfoundation.org/mailman/listinfo/vm-dev;I1,I1,,b,,i,b,I1,Rhttps://github.com/hpi-swa-lab/SqueakByExample-english;I1,I1,Rhttps://github.com/hpi-swa-lab/SqueakByExample-english/releases;I1,I1,,i,,I1,Rhttps://squeak.org/documentation/#books;I1!!' readStream nextChunkText) - Many books about Squeak and Smalltalk in general have been made available: - https://squeak.org/documentation/#books!! - ]style[(11 19 2 23 50 23 1 15 23 1 27 2 32 32 49 2 13 1 1 11 135 2 61 2 10 2 132 62 2 14 145 64 2 6 134 58 2 5 2 17 2 188 54 63 63 2 11 78 39)b,I0i,I0,Rhttps://www.squeak.org;,I0,Rhttps://bugs.squeak.org;,I0,I0i,Rhttps://news.squeak.org;,I0,I0i,I0,Rhttps://www.squeak.org/downloads;,I0,Rhttps://github.com/OpenSmalltalk/opensmalltalk-vm;,I0,I0b,I0,,i,,b,Rhttps://lists.squeakfoundation.org/mailman/listinfo/beginners;,,i,b,,Rhttps://lists.squeakfoundation.org/mailman/listinfo/squeak-dev;,,i,,Rhttps://lists.squeakfoundation.org/mailman/listinfo/vm-beginners;,,i,,Rhttps://lists.squeakfoundation.org/mailman/listinfo/vm-dev;,,b,,i,b,,Rhttps://github.com/hpi-swa-lab/SqueakByExample-english;,,Rhttps://github.com/hpi-swa-lab/SqueakByExample-english/releases;,,i,,Rhttps://squeak.org/documentation/#books;!!' readStream nextChunkText) key: #squeakResourcesOnline; shouldStyle: false; yourself! Item was changed: ----- Method: SqueakToolsTranscriptHelp class>>transcript (in category 'pages') ----- transcript "This method was automatically generated. Edit it using:" "SqueakToolsTranscriptHelp edit: #transcript" <generated> ^(HelpTopic title: 'The Transcript window' contents: 'The Transcript window is often used for logging or printing results from text only code. To open the Transcript use TheWorldMenu and choose ''open...''. Then choose ''Transcript''. You can also type Transcript open in a Workspace and doIt. + To write anything into the Transcript, send #show: or #showln: to it: - To write anything into the Transcript, send it #show: or #showln:: Transcript showln: ''Hello world!!!!''. Transcript show: '' :-)''.!! + ]style[(197 16 6 9 56 6 4 8 9 59),I1,,Rcode://Workspace open;,,LTranscriptStream show:;,,LTranscriptStream showln:;,,I1!!' readStream nextChunkText) - ]style[(197 16 6 9 59 6 4 8 3 59),I1,,Rcode://Workspace open;,,LTranscriptStream show:;,,LTranscriptStream showln:;,,I1!!' readStream nextChunkText) key: #transcript; shouldStyle: false; yourself!
More information about the Squeak-dev mailing list |