sketchucation logo sketchucation
    • Login
    ℹ️ Licensed Extensions | FredoBatch, ElevationProfile, FredoSketch, LayOps, MatSim and Pic2Shape will require license from Sept 1st More Info

    Collaborative Effort - Ruby Template, RDoc, and Localization

    Scheduled Pinned Locked Moved Developers' Forum
    36 Posts 13 Posters 10.0k Views 13 Watching
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • thomthomT Offline
      thomthom
      last edited by

      Looks good by the first glance.

      I want to have a look into how easy it is to reliably extract plugin data in regards to auto updaters etc. Maybe include an compatible list, a list that states which SU version it's compatible. And optionally, and list of plugins that might be incompatible with?

      What I'd like as alternative for the text is where it's allowed to copy, modify and distribute for non-commercial use. I'm not really sure how it's best phrased these sort of things.

      Thomas Thomassen — SketchUp Monkey & Coding addict
      List of my plugins and link to the CookieWare fund

      1 Reply Last reply Reply Quote 0
      • M Offline
        Matt666
        last edited by

        Good idea Rick!
        Thank you for this suggestion...

        Frenglish at its best !
        My scripts

        1 Reply Last reply Reply Quote 0
        • H Offline
          Heven7_floor
          last edited by

          Great and beautiful idea 👍 ! Are there any helping for amateurish codding ? , such event block code suggestion ,as collection of necessary or most usage event
          ex.

             Class *name...
                def initial
                ...
                end 
                def onMouseMove(flags, x, y, view)
                ...
                end
                def onLButtonDown(flags, x, y, view)
                ...
                end
             end
          
          
                  as the one who expertise codder shall please to new face like me for most usefully event suggestion for SU script codding   :tada:
          
          1 Reply Last reply Reply Quote 0
          • GaieusG Offline
            Gaieus
            last edited by

            @rickw said:

            I'm not an attorney, but this might work:
            Permission to use, copy, modify, and distribute this software for noncommercial purposes and without fee is hereby granted, provided that the above copyright notice appear*s** in all copies. Commercial distribution, in whole or in part, is expressly prohibited without the express**ed,** written consent of the author.*

            Well, I AM a lawyer, too, and I think it's okay.
            I used to be an English teacher, too... 😳

            Gai...

            1 Reply Last reply Reply Quote 0
            • Chris FullmerC Offline
              Chris Fullmer
              last edited by

              @gaieus said:

              Well, I AM a lawyer, too, and I think it's okay.
              I used to be an English teacher, too... 😳

              Aren't you a little over-qualified to be goofing around on the forum all the time then? 🤣

              Lately you've been tan, suspicious for the winter.
              All my Plugins I've written

              1 Reply Last reply Reply Quote 0
              • scottliningerS Offline
                scottlininger
                last edited by

                Purely my bias, but I'd lean toward the RDoc comment style. Either way, this looks extremely helpful!

                • Scott Lininger
                  SketchUp Software Engineer
                  Have you visited the Ruby API Docs?
                1 Reply Last reply Reply Quote 0
                • GaieusG Offline
                  Gaieus
                  last edited by

                  @chris fullmer said:

                  ...Aren't you a little over-qualified to be goofing around on the forum all the time then? 🤣

                  Wait till I have the time to finish my PhD thesis! 😄

                  Gai...

                  1 Reply Last reply Reply Quote 0
                  • R Offline
                    RickW
                    last edited by

                    @unknownuser said:

                    Purely my bias, but I'd lean toward the RDoc comment style. Either way, this looks extremely helpful!

                    Using RD or RDoc style would be more consistent with the =begin/=end usage (rather than using it for block comments). Something like this?

                    # Supports Organizer.rb
                    
                    =begin rdoc
                    = ScriptName
                    Copyright 2009, Author
                    All Rights Reserved
                    
                    == Disclaimer
                    THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                    
                    == License
                    author's license statement
                    
                    == Information
                    Author;; AuthorName
                    Organization;; AuthorAffiliationOrOrganizationIfAny
                    Name;; ScriptName
                    Version;; ScriptVersion
                    SU Version;; MinimumSketchUpVersion
                    Date;; Date
                    Description;; ScriptDescription
                    Usage;; ScriptUsageInstructions
                    History;;
                     1.000;; YYYY-MM-DD
                       * description1
                       * description2
                     1.001;; YYYY-MM-DD
                       * description1
                       * description2
                    
                    =end
                    
                    require "sketchup.rb"
                    
                    
                    
                    unless file_loaded?(__FILE__)
                       file_loaded(__FILE__)
                       UI.add_context_menu_handler do |menu|
                          menu.add_item("menuitem") { code } # CREATE A SINGLE MENU ITEM IN CONTEXT MENU
                          submenu = menu.add_submenu("submenu") # CREATE A SUBMENU ITEM IN CONTEXT MENU
                             submenu.add_item("menuitem1") { code }
                             submenu.add_item("menuitem2") { code }
                       end
                       $submenu ? (organizer = $submenu) ; (organizer = UI.menu("Plugins"))
                       organizer.add_item("menuitem") { code } # CREATE A SINGLE MENU ITEM
                       submenu = organizer.add_submenu("submenu") # CREATE A SUBMENU ITEM
                          submenu.add_item("menuitem1") { code }
                          submenu.add_item("menuitem2") { code }
                    end
                    
                    
                    

                    RickW
                    [www.smustard.com](http://www.smustard.com)

                    1 Reply Last reply Reply Quote 0
                    • thomthomT Offline
                      thomthom
                      last edited by

                      @unknownuser said:

                      Purely my bias, but I'd lean toward the RDoc comment style. Either way, this looks extremely helpful!

                      I'm in favour of using an existing method of documentation.

                      Thomas Thomassen — SketchUp Monkey & Coding addict
                      List of my plugins and link to the CookieWare fund

                      1 Reply Last reply Reply Quote 0
                      • scottliningerS Offline
                        scottlininger
                        last edited by

                        @rickw said:

                        Using RD or RDoc style would be more consistent with the =begin/=end usage (rather than using it for block comments). Something like this?

                        Exactly. I didn't run this though RDoc to see the output, but my point is that RDoc is the closest thing to a docs standard that I'm aware of. Might as well build something that could be run through RDoc and give sensible output.

                        Now you should extend the template list and build a Ruby plugin wizard! 😉 (only half joking.)

                        • Scott Lininger
                          SketchUp Software Engineer
                          Have you visited the Ruby API Docs?
                        1 Reply Last reply Reply Quote 0
                        • thomthomT Offline
                          thomthom
                          last edited by

                          This is shaping up good. 😄

                          I'm wondering, for the changelog, does the RDoc have a syntax for lists? Just thinking there's something that might denote a list item. I don't find enough space on one line to describe a change some times. I've up til now used a * to indicate list items.

                          Like this:

                          
                          # Changelog
                          # 1.0.0 - 13.12.2008
                          #       * Select Active Instances
                          #       * Select Instances
                          #       * Select Active Group Copies
                          #       * Select Group Copies
                          #       * Convert Group Copies to Instances
                          #
                          # 1.1.2 - 16.12.2008
                          #       * Select Loop from edge
                          
                          

                          If the description breaks to another line the * makes it clear when the next item starts.
                          So if there's an RDoc syntax for this I suggest we use that.

                          Also, in addition to SU version, OS Platform is useful as some scripts works only on either Mac or PC.

                          And, I'm wondering if it's worth to include a Webdialog engine, since some plugins fail due to the user having an old IE version installed. (Not sure how it's on OSX. The rendering engine is webkit, right? but does it change if you update Safari?)

                          Thomas Thomassen — SketchUp Monkey & Coding addict
                          List of my plugins and link to the CookieWare fund

                          1 Reply Last reply Reply Quote 0
                          • R Offline
                            RickW
                            last edited by

                            @thomthom said:

                            I want to have a look into how easy it is to reliably extract plugin data in regards to auto updaters etc. Maybe include an compatible list, a list that states which SU version it's compatible. And optionally, and list of plugins that might be incompatible with?

                            It should be straightforward, using a regexp to parse the file. The fields are known (that's the point of this exercise), so writing a parser should be easy. The challenge, IMO, is to keep it easily human-readable, while allowing machine readability.

                            @thomthom said:

                            What I'd like as alternative for the text is where it's allowed to copy, modify and distribute for non-commercial use. I'm not really sure how it's best phrased these sort of things.

                            I'm not an attorney, but this might work:
                            Permission to use, copy, modify, and distribute this software for noncommercial purposes and without fee is hereby granted, provided that the above copyright notice appear in all copies. Commercial distribution, in whole or in part, is expressly prohibited without the expressed, written consent of the author.

                            Edited per Gai. I found both "express written" and "expressed written" online, didn't know if one was more correct for legal jargon.

                            RickW
                            [www.smustard.com](http://www.smustard.com)

                            1 Reply Last reply Reply Quote 0
                            • R Offline
                              RickW
                              last edited by

                              There is a list syntax. See the RDoc docs for more info.

                              RickW
                              [www.smustard.com](http://www.smustard.com)

                              1 Reply Last reply Reply Quote 0
                              • T Offline
                                todd burch
                                last edited by

                                I'm on this like a Hobo on a Bologna sandwich.

                                Get your requests in now, during the early design stages. We're gonna have a GUI!!!

                                Stay tuned. Todd

                                1 Reply Last reply Reply Quote 0
                                • R Offline
                                  RickW
                                  last edited by

                                  Developers,

                                  Please note that the menu information is also part of the template, designed to function with Organizer.rb (even though Organizer.rb is NOT required for the menu to work).

                                  If you choose to not use this menu template, please also remove the top line of the header "# Supports Organizer.rb". Otherwise, users trying to use OrganizerEdit to make your work compatible with Organizer will not be able to do so. Then I'll get support requests, and I'll have to forward them on to you to fix the issues 😄

                                  Here is the documentation for creating Organizer-compatible menus (though the work has already been done in this template)

                                  RickW
                                  [www.smustard.com](http://www.smustard.com)

                                  1 Reply Last reply Reply Quote 0
                                  • R Offline
                                    RickW
                                    last edited by

                                    I'm considering adding this to the ruby template, but wanted to get input. After a rather infamous incident recently, I thought about easing the localization effort for menus, and came up with this:

                                    1. create a "menus" subfolder in the Plugins folder (to keep things tidy)

                                    2. in that folder, create a text file with the same name as your .rb file, with the extension ".menu" and put each menu item text string on a separate line, like this (the submenu, submenu2, etc names are only to illustrate where they are in the menu structure for this particular example):

                                    context menu label
                                    submenu label
                                    submenu item label
                                    submenu2 label
                                    submenu2 item1 label
                                    submenu2 item2 label
                                    submenu2 item3 label
                                    submenu2 item4 label
                                    submenu2 item5 label
                                    submenu2 item6 label
                                    
                                    # This file may be translated for localization
                                    
                                    
                                    1. use the following example code to read the lines from the .menu file into your menu structure:
                                    unless file_loaded?(__FILE__)
                                    	file_loaded(__FILE__)
                                    	menunames = IO.readlines(File.dirname(__FILE__)+"/menus/"+File.basename(__FILE__, ".rb")+".menu").collect{|x| x.chop}
                                    	UI.add_context_menu_handler do |menu|
                                    		menu.add_item(menunames[0]) { code }
                                    	end
                                    	$submenu ? (organizer = $submenu) ; (organizer = UI.menu("Plugins"))
                                    	submenu = organizer.add_submenu(menunames[1])
                                    		submenu.add_item(menunames[2]) { code }
                                    		submenu2 = submenu.add_submenu(menunames[3])
                                    			submenu2.add_item(menunames[4]) { code }
                                    			submenu2.add_item(menunames[5]) { code }
                                    
                                    			submenu2.add_separator
                                    
                                    			submenu2.add_item(menunames[6]) { code }
                                    			submenu2.add_item(menunames[7]) { code }
                                    			submenu2.add_item(menunames[8]) { code }
                                    			submenu2.add_item(menunames[9]) { code }
                                    end
                                    
                                    

                                    This particular example does everything except submenus and separators for the context menu.

                                    As I see it, this will make localization a breeze, since someone only has to translate the .menu file, which is plain text. It also eliminates copyright problems, since the code is unchanged.

                                    Thoughts?

                                    RickW
                                    [www.smustard.com](http://www.smustard.com)

                                    1 Reply Last reply Reply Quote 0
                                    • thomthomT Offline
                                      thomthom
                                      last edited by

                                      So use user completely replaces the menu language file?

                                      Just wondering about packaging. What if you want to include multiple language packs? (Or maybe this isn't the scope for this? This is purely a bare minimum way of allowing localization?)

                                      Thomas Thomassen — SketchUp Monkey & Coding addict
                                      List of my plugins and link to the CookieWare fund

                                      1 Reply Last reply Reply Quote 0
                                      • T Offline
                                        todd burch
                                        last edited by

                                        I smell a good application for an XML file.

                                        1 Reply Last reply Reply Quote 0
                                        • T Offline
                                          todd burch
                                          last edited by

                                          Maybe something like this:

                                          
                                          <?xml version="1.0" encoding="UTF-8"?> 
                                          <menufile>
                                          	<mainmenu name="Tools">
                                          		<item>My Ruby Script V1.0</item> 
                                          		<submenu text="First Submenu">
                                          			<item>Function 1</item>
                                          			<item>Function 2</item>
                                          			<sep/> 
                                          			<item>Function 3</item>
                                          		</submenu>
                                          		<submenu text="Help">
                                          			<item>Contact Author</item>
                                          			<item>User's Guide</item>
                                          			<item>YouTube Video</item>
                                          		</submenu>
                                          	</mainmenu>
                                          </menufile>
                                          
                                          1 Reply Last reply Reply Quote 0
                                          • R Offline
                                            RickW
                                            last edited by

                                            @thomthom said:

                                            So use user completely replaces the menu language file?

                                            Just wondering about packaging. What if you want to include multiple language packs? (Or maybe this isn't the scope for this? This is purely a bare minimum way of allowing localization?)

                                            Someone replaces the contents of that file, yes. As far as Smustard goes, my goal is to have all our menu items converted over, and users could download "language packs" of the whole library of .menu files for their language (we'll see how quickly that gets done). 😄

                                            My goals in leaving it plain text is that it is most accessible (IMO) that way and it requires the least amount of processing in the ruby script, but there might be drawbacks. Input is definitely welcome.

                                            Obviously, for other authors, the issue is slightly more complicated, but only slightly. Each menu file could be appended with the proper country extension (for example, "myrubyscript-de.menu", "myrubyscript-mx.menu", "myrubyscript-enUS.menu" etc) and then the user removes the extension for the one they want to use ("myrubyscript.menu"). For Windowizer4, I tried making it automatic based on the SU-reported locale, but that was not reliable and so most users ended up renaming the .html file anyway.

                                            RickW
                                            [www.smustard.com](http://www.smustard.com)

                                            1 Reply Last reply Reply Quote 0
                                            • 1
                                            • 2
                                            • 1 / 2
                                            • First post
                                              Last post
                                            Buy SketchPlus
                                            Buy SUbD
                                            Buy WrapR
                                            Buy eBook
                                            Buy Modelur
                                            Buy Vertex Tools
                                            Buy SketchCuisine
                                            Buy FormFonts

                                            Advertisement