Alpha Software Mobile Development Tools:   Alpha Anywhere    |   Alpha TransForm subscribe to our YouTube Channel  Follow Us on LinkedIn  Follow Us on Twitter  Follow Us on Facebook

Announcement

Collapse

The Alpha Software Forum Participation Guidelines

The Alpha Software Forum is a free forum created for Alpha Software Developer Community to ask for help, exchange ideas, and share solutions. Alpha Software strives to create an environment where all members of the community can feel safe to participate. In order to ensure the Alpha Software Forum is a place where all feel welcome, forum participants are expected to behave as follows:
  • Be professional in your conduct
  • Be kind to others
  • Be constructive when giving feedback
  • Be open to new ideas and suggestions
  • Stay on topic


Be sure all comments and threads you post are respectful. Posts that contain any of the following content will be considered a violation of your agreement as a member of the Alpha Software Forum Community and will be moderated:
  • Spam.
  • Vulgar language.
  • Quotes from private conversations without permission, including pricing and other sales related discussions.
  • Personal attacks, insults, or subtle put-downs.
  • Harassment, bullying, threatening, mocking, shaming, or deriding anyone.
  • Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory jokes and language.
  • Sexually explicit or violent material, links, or language.
  • Pirated, hacked, or copyright-infringing material.
  • Encouraging of others to engage in the above behaviors.


If a thread or post is found to contain any of the content outlined above, a moderator may choose to take one of the following actions:
  • Remove the Post or Thread - the content is removed from the forum.
  • Place the User in Moderation - all posts and new threads must be approved by a moderator before they are posted.
  • Temporarily Ban the User - user is banned from forum for a period of time.
  • Permanently Ban the User - user is permanently banned from the forum.


Moderators may also rename posts and threads if they are too generic or do not property reflect the content.

Moderators may move threads if they have been posted in the incorrect forum.

Threads/Posts questioning specific moderator decisions or actions (such as "why was a user banned?") are not allowed and will be removed.

The owners of Alpha Software Corporation (Forum Owner) reserve the right to remove, edit, move, or close any thread for any reason; or ban any forum member without notice, reason, or explanation.

Community members are encouraged to click the "Report Post" icon in the lower left of a given post if they feel the post is in violation of the rules. This will alert the Moderators to take a look.

Alpha Software Corporation may amend the guidelines from time to time and may also vary the procedures it sets out where appropriate in a particular case. Your agreement to comply with the guidelines will be deemed agreement to any changes to it.



Bonus TIPS for Successful Posting

Try a Search First
It is highly recommended that a Search be done on your topic before posting, as many questions have been answered in prior posts. As with any search engine, the shorter the search term, the more "hits" will be returned, but the more specific the search term is, the greater the relevance of those "hits". Searching for "table" might well return every message on the board while "tablesum" would greatly restrict the number of messages returned.

When you do post
First, make sure you are posting your question in the correct forum. For example, if you post an issue regarding Desktop applications on the Mobile & Browser Applications board , not only will your question not be seen by the appropriate audience, it may also be removed or relocated.

The more detail you provide about your problem or question, the more likely someone is to understand your request and be able to help. A sample database with a minimum of records (and its support files, zipped together) will make it much easier to diagnose issues with your application. Screen shots of error messages are especially helpful.

When explaining how to reproduce your problem, please be as detailed as possible. Describe every step, click-by-click and keypress-by-keypress. Otherwise when others try to duplicate your problem, they may do something slightly different and end up with different results.

A note about attachments
You may only attach one file to each message. Attachment file size is limited to 2MB. If you need to include several files, you may do so by zipping them into a single archive.

If you forgot to attach your files to your post, please do NOT create a new thread. Instead, reply to your original message and attach the file there.

When attaching screen shots, it is best to attach an image file (.BMP, .JPG, .GIF, .PNG, etc.) or a zip file of several images, as opposed to a Word document containing the screen shots. Because Word documents are prone to viruses, many message board users will not open your Word file, therefore limiting their ability to help you.

Similarly, if you are uploading a zipped archive, you should simply create a .ZIP file and not a self-extracting .EXE as many users will not run your EXE file.
See more
See less

Documentation?

Collapse
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

    Documentation?

    Looking at the various uploaded databases it occurs to me that there is not a generally held place to put documentation. I'm thinking mostly of the 'notes to self' sort of designer notes that are sometimes tucked into source code.

    While it is of course possible to include a readme.txt file I don't often look at the component files of the directory. I suppose you could have a Report or Form with designer notes -- but I'd really like something that showed up under the Code Tab. That way it wouldn't be visible to the runtime.

    Is there a script or code format that can never be executed, that the db would always ignore? Something people might use to leave notes to themselves or fellow maintainers?

    Bo

    #2
    RE: Documentation?

    Bo, this is a good question. My practice is to keep a journal using my favorite word processor, storing it in the database folder during development.

    I suppose it wouldn't be too hard to create another table and use it to track changes and development ideas. If memory serves Barry Rochford has published an article explaining how he does it. You might check the articles index at www.learn alpha.com.

    -- tom

    Comment


      #3
      RE: Documentation?

      Bo,

      By the way, I'm curious about why you think items on the Code page are less visible to the runtime than layouts listed on the Form or Report pages ? Since the runtime can't get to the control panel aren't they all equally invisible ?

      -- tom

      Comment


        #4
        RE: Documentation?

        Bo,

        Tom has the best thoughts about using a table to store your "memos" in. The downside would be that the table would show in the control panel of a runtim IF you allow the user to see/ access the CP.

        If you just want to keep notes in the code tab as a script you could create a script, make the first line END and then use comments to keep your notes.

        Personally, I would take Tom's advise of using the table and then just password protect it IF the user has access to the CP. This will allow you to use all the formatting and search features of A5 to make your life easier.

        Scott

        Comment


          #5
          RE: Documentation?

          Hi Guys,

          Using Tom's approach seems to be the best. I'd like to add that possibly placing that table outside of the DB folder and having a hidden button on the main menu to display or print it. I just don't know if it would show then in the CP.

          Might work?
          efs

          Comment


            #6
            RE: Documentation?

            Bo

            In addition to the ideas already mentioned, you can leave comments directly in the code. To commnet a line out in xbasic, just place single quote (') at the start of a line and the program ignored that line. I like to leave some comments in the code for my own information to explain what the code is doing. For example, here would be a typical comment section in an xbasic script

            '--------- Start Process ----------
            'These would be comment lines explaining what happens next
            ' This could be something like:
            ' Calculates balance by subtracting payments from balance
            ' Places result in customer file
            '--------- End Comments ------------

            I have found this a good way to place simple notes. If more extensive information is needed, I create a work processor file that has notes on what I am doing.

            Jerry

            Comment


              #7
              RE: Documentation?

              Tom

              In the runtime happenstance might give users access to the Control Panel but the code window is automatically hidden. Right click inside of the runtime control panel and try to enable the code window -- it isn't there.

              Like you Tom, I also keep a second editor running with snippits of code, words o wisdom, project notes etc... (I think I mentioned this before.) I like the code window because its both the most flexible and the most simple. Copy to or from my editor .

              Could you have a standard readme header that would open a web page or send an email if the script was run? Then one could explain the application with the rest of the script.

              I'm thinking mostly for adding helpfiles to example applications. I'd like to comment a DB from the Phorum with the message text that describes it in a script called U_Readme_A5.

              Unfortunately even after an 'end' the imported text needs to be commented or it appears as an error and the editor won't close. I'd like to make Alpha completly ignore the import in some sort of remark block.

              I dont think that pure text files would ever be very big. I don't know if their size or management would become an issue.

              I hope you will forgive me if I illustrate with one of your own files (and your own words :) ).

              Comment


                #8
                RE: Documentation?

                How about keeping it in a table, but dropping the table from the database before distribution. Leave the table in the database folder so it's there, but it wouldn't be visible to the end user even if they have access to the control panel. You could even add a bit of password protected code that would add the table back to the database so it would become available if needed, and a way to drop it again when you were done.

                Comment


                  #9
                  RE: Documentation?

                  Isn't he really just asking for implementation of remark blocks in the editor so you could mark the beginning of imported text and the end of imported text without adding a remark symbol to each line -- or as an alternative, highlight all of the imported lines and let the editor insert remark symbols as some editors do?

                  Comment


                    #10
                    RE: Documentation?

                    Thanks Paul

                    I guess that is what I'm asking for (The former -- mark beginning and end). But I also wonder if others would use this system and if anyone can, constructively, kick holes in it for me.

                    Bo

                    Comment


                      #11
                      RE: Documentation?

                      highlight all of the imported lines and let the editor insert remark symbols as some editors do?

                      This capability is already there. Highlight your block of text and hit CTRL+' or click the toolbar icon (see attached image). You can also uncomment a block with the next icon on the toolbar (also in image) or with CTRL+;

                      -Lenny

                      Lenny Forziati
                      Vice President, Internet Products and Technical Services
                      Alpha Software Corporation

                      Comment

                      Working...
                      X