We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 17544
    • 86 Posts
    Don’t you guys thinks Chunks and Snippets should me merge into just Snippets? The new Snippet will have an option to mark if it is ’PHP code’ . This way both can share the same table and most important, they share the same modxtag. And a static ’chuck’ can easily be converted to a dynamic ’chunk’ later without the need to create a new snippet and change all the old tags in the exiting documents. It also reduce 1 technial word (aka chunk) and 1 tab space in the resources section. laugh
      • 6726
      • 7,075 Posts
      In fact I remember there was talk about that among the team, a while ago...
        .: COO - Commerce Guys - Community Driven Innovation :.


        MODx est l'outil id
        • 31037
        • 358 Posts
        Quote from: lovingmodx at Nov 07, 2006, 04:34 AM

        Don’t you guys thinks Chunks and Snippets should me merge into just Snippets?
        I wote for that!

        We could call them "Chunkpets" wink
          • 17544
          • 86 Posts
          Quote from: Uncle68 at Nov 07, 2006, 04:48 AM

          Quote from: lovingmodx at Nov 07, 2006, 04:34 AM

          Don’t you guys thinks Chunks and Snippets should me merge into just Snippets?
          I wote for that!

          We could call them "Chunkpets" wink

          Wuhahahhaa! CHUNKPETS! We have new pets for MODx! laugh
            • 28676
            • 136 Posts
            or whippets grin
              I made my first site with modx
              ------------------------
              http://www.shop-bright.com | Uk shopping blog
              • 22815
              • 1,097 Posts
              Indeed, if you look at the code and database, you’ll see that Chunks are called "htmlsnippets". Personally, I’m happy with the separation and the two terms, as "chunk" and "snippet" are easier to say than "HTML Snippet" and "PHP Snippet".

              Quote from: lovingmodx at Nov 07, 2006, 01:29 AM

              Yep, I agree on this. There should be some kind of ’TV’ that is universal, once created will be available to all documents (so it can no longer call TV, haha). I think of TV as some extra data that I can attach to my document, for example if all my contents is about books, I will create 2 TVs call ISBN and Author. It really has nothing to do with template. It is more an EV - Extra Variables. My friend created a TV and couldn’t find a way to use it the whole day, until he find out that he need to enable the specific template for that specific TV! So the logic behind TV is hard to grasp.
              I’m confused - you say they’re nothing to do with templates and shouldn’t be called Template Variables, but then give an example of someone not realising that there needs to be some relation of the TV to the template! That’s why they’re called template variables - they are variables that are available with that template. You can already add your TVs to all available templates - although if you then add another template, you’d have to go around adding them. As far as I can tell, the benefit of restricting TVs to certain templates is to avoid having inappropriate variables on pages; it would probably confuse people to have ’GoogleMapReference’ available on your contact form edit page as well as the office branch pages. Or an ISBN on an Author Bio page. At the present time, the only way of distinguishing document format is template. Which makes perfect sense to me because "template" refers to structure and layout, not just layout. In most other systems, template just means look and feel. MODx does not have such a narrow view.

              However, I can see that an an ’Available To All Templates’ option would be useful, and I can also see some benefit in making it the default in future MODx versions, as long as there is still the ability to restrict variables to appropriate subsets of documents.

              Right now, this seems to be something that just needs documenting properly. I have great hopes for the Wiki being able to document things from multiple angles.

              Quote from: lovingmodx at Nov 07, 2006, 01:29 AM

              Please! Write some documentation and examples for ditto. The current documentation is a list of features (not documentation). There isn’t enough explanation, tutorials and examples!
              Well, the author is busy, and his priority is the next version anyway. There’s an entire subforum dedicated to Ditto : http://modxcms.com/forums/index.php/board,180.0.html and I intend to summarise some of the problems and solutions over on the wiki. Hopefully other people will help with that.

              Quote from: straty at Nov 07, 2006, 02:07 AM

              I think all modules before getting listed on the site should have full install instructions and lots of examples and "how to do this" type of stuff. Also some of them need a requirements list, I installed a module that didnt work with mysql version that I had running.

              If a module doesn’t have full install instructions and lots of examples, just imagine it isn’t there. Do that for all the add-ons that have not been documented to a commercial standard, and you’d find very little left. This is the nature of open source, I’m afraid. People are far more likely to share something they’ve just written to solve a problem they had if they’re not expected to spend possibly longer than it took to write the add-on putting together documentation themselves. Please, community, you can help with documenting things! Even if it’s just compiling a list of questions for others to answer, or letting the next person know that a module doesn’t work with a particular MySQL version. It all helps.
                No, I don't know what OpenGeek's saying half the time either.
                MODx Documentation: The Wiki | My Wiki contributions | Main MODx Documentation
                Forum: Where to post threads about add-ons | Forum Rules
                Like MODx? donate (and/or share your resources)
                Like me? See my Amazon wishlist
                MODx "Most Promising CMS" - so appropriate!
                • 28676
                • 136 Posts

                If a module doesn’t have full install instructions and lots of examples, just imagine it isn’t there. Do that for all the add-ons that have not been documented to a commercial standard, and you’d find very little left. This is the nature of open source, I’m afraid. People are far more likely to share something they’ve just written to solve a problem they had if they’re not expected to spend possibly longer than it took to write the add-on putting together documentation themselves. Please, community, you can help with documenting things! Even if it’s just compiling a list of questions for others to answer, or letting the next person know that a module doesn’t work with a particular MySQL version. It all helps.

                Ok point taken and its a fair point but If I cant install and use it myself how can I write or re-write helpfull instructions - i`ve already edited a few wiki’s to make it easier for designers like me.
                  I made my first site with modx
                  ------------------------
                  http://www.shop-bright.com | Uk shopping blog
                  • 22815
                  • 1,097 Posts
                  That’s also a good point, and clearly authors should do *some* documentation, and I think you’re right to expect a certain level of installation instruction, just not necessarily what one might term "full".

                  Everyone: If you find a module or add-on that has inadequate installation instructions, please feel free to PM me. I have moderator privileges on the Repository and so I can add and amend the details there, improving installation instructions. I’m not guaranteeing any instant response, particularly if it’s not clear to me either, but I’ll do my best to help.
                    No, I don't know what OpenGeek's saying half the time either.
                    MODx Documentation: The Wiki | My Wiki contributions | Main MODx Documentation
                    Forum: Where to post threads about add-ons | Forum Rules
                    Like MODx? donate (and/or share your resources)
                    Like me? See my Amazon wishlist
                    MODx "Most Promising CMS" - so appropriate!
                    • 27708 MODX Staff
                    • 2,502 Posts
                    This thread just keeps getting better.

                    On the topic of addon documentation: it might not be a bad idea to create a simple minimum standard for items. This might include description, usage, installation, and one or two contextual examples. This could possibly be a condition of having them listed in the repository.

                    That being said I don’t think that addon devs should be burdened with this entire job and that addons should make their way up through the forum, have the time to mature, and have some of the common issues worked out prior to being moved into the repository. Users, contributers and forum members can all add to the doc project for each of the addons. Once the minimum standard has been met it can then be relocated to the Repository.

                    Let the ideas flow. This thread keeps me coming back for more.

                    ATB,

                    Jay
                      Author of zero books. Formerly of many strange things. Pairs well with meats. Conversations are magical experiences. He's dangerous around code but a markup magician. Blog ✦ Twitter ✦ LinkedIn ✦ GitHub
                      • 22815
                      • 1,097 Posts
                      There are already fields; making more fields mandatory overcomplicates things for the simple snippets. Sometimes you just want to put up a resource today and put the documentation in the next day.

                      Users can and should look whether there is enough detail to see if they are confident to install the add-on.

                      I agree in principle that complex add-ons should debut in the forums first and if a dev wants help with the documentation, he/she should ask for it there.
                        No, I don't know what OpenGeek's saying half the time either.
                        MODx Documentation: The Wiki | My Wiki contributions | Main MODx Documentation
                        Forum: Where to post threads about add-ons | Forum Rules
                        Like MODx? donate (and/or share your resources)
                        Like me? See my Amazon wishlist
                        MODx "Most Promising CMS" - so appropriate!