DroidScript Documentation is ready

[Symbroson]

 Hi Folks,

I can finally announce that the DroidScript documentation is ready. Took me long enough.

This documentation is going to be included in one of the following beta releases - look forward to it :)

I have shared some more infos in the beta forum: https://groups.google.com/forum/#!topic/droidscriptbeta/CqpbNNp-IYQ

If you want to take a look please join the beta forum.

I specifically need some people to report any spelling mistakes, bad formulations, missing or even wrong information etc.

I'm also open for any feedback and/or further improvement suggestions.

Thanks in advance :)

[fython]

How do I join the beta forum?

[Symbroson]

Send a request to sup...@droidscript.org that you want to join beta

[samkm]

Oh this is awesome! Love Droidscript so much but it's like feeling around in the dark sometimes the way it is, thanks for taking the time to do this, looking forward to the update ^_^

[Ignas Bukys]

Idea: What about making documentation more open-source? I mean share on github so anyone could contribute and easily register issues about incorrect instructions?

Or maybe there are some things why this cannot be done and I do not see...

[Symbroson]

The docs are open source. The links are shared in the beta forum.

Preview: https://alex-symbroson.github.io/Docs

Production repository: https://github.com/alex-Symbroson/Docs

Readme for contributors: https://github.com/DroidScript/Docs/blob/master/files/README.md (will be updated later today)

[Justin blAblA]

you can find the github here:
https://github.com/alex-Symbroson/Docs

[Ignas Bukys]

Thanks for the links. Glad to see progress on documentation

[Munawar Hussain]

Hello everyone.

Is there a way to get pdf to print or printed book ?

Allah (God) creator of whole universe, please protect us and cure us. Aameen.

Thank you

[Symbroson]

Please create a new thread if you have a question which is not directly related to the current topic.

Also you might have good intentions but this is not the appropriate place for religious statements. Please refrain from doing that in the future.

[ReJo Lu]

I'm newbie, using only HTML. I just wanted to ask on how to change icon in making html app..plse answer my question, plss😃

Isinulat ni Symbroson noong Biyernes, Hulyo 3, 2020 nang 12:54:58 AM UTC+8:

[Alan Hendry]

Hi,

When I open the DocsPreview app, then Update lets me choose Beta.

(Release Notes then includes 211b).

Might be worth including instructions on how to get DocsPreview in this thread.

Uri2Path has UriPath in the heading, and the Example is actually to Catch App Errors

Some options are well documented (like CreateImage>Options>NoPlay)

and some aren't (like CreateImage>Options>fix).

Reference>Premium doesn't include AddCodeEdit, CreateCloud, CreatePlayStore, CreateWizard, GA.

Regards, ah

[Alan Hendry]

On 

SendIntent has a link  

  You can find some common used examples for that in the DroidScript Wiki

Which goes to 

  https://wiki.droidscript.me.uk/doku.php?id=intents:open_apps&s[]=sendintent

with error

  This site can’t be reached

Should probably be 

  https://droidscript.org/wiki/doku.php?id=intents:start

[Alan Hendry]

Hi,

CreateCustomTabs has a link

See the plugin documentation for details

that goes to 

https://symdstools.github.io/Docs/docs/app/plugins/customTabs/CustomTabs.html

with error 404 (page not found)

https://groups.google.com/g/droidscriptbeta/c/uwxXQdor9eg/m/4E5LLzrjCAAJ  23 Jul 2021, 21:29:52

says " I added a new method called app.RealPath()" is that in the new docs?

Many pages have tooltip/popups like String: url path, and clicking on the word String goes to 

https://symdstools.github.io/Docs/docs/javascript/Global_Objects/String.html

Page Not found (404)

https://groups.google.com/g/droidscriptpremium/c/Fuma1McqGL4 

mentions SetIconTouch for  MUI.CreateTEOutlineIconRight (and Left)

Regards, ah

[Alan Hendry]

Hi,

Forgot to mention that the 404 error from clicking String is on the online docs.

https://gineerslife.com/get-mui-post?postId=0 mentions changes like 

    DroidScript will soon support Add*** methods in calling the controls.

Not sure what version of DS that'll be in (or when it should be added to the docs).

Regards, ah

[Alan Hendry]

Hi,

On https://symdstools.github.io/Docs/docs/Docs.htm

 there's a link for Music that goes to 

https://symdstools.github.io/Docs/docs/Music/Music.html

Page Not Found (404)

Regards, ah

[Alan Hendry]

Hi,

GetPosition actually returns left,top width,height

(not left,top,right,bottom)

Probably applies to a whole bunch of objects.

Regards. ah

[Alan Hendry]

HI,

SmartEdit for AddDrawer shows a 4th parameter for grab handle width.

Doesn't seem to be in the docs.

Not sure if it should be a number 0 to 1 or a number of pixels.

I did a quick test and it doesn't seem to work (for 0.2 or 20).

Regards, ah

[Alan Hendry]

HI,

Many objects have GetHeight and GetAbsHeight (ditto for Width)

I presume that one includes the margin, and the other doesn't.

Could the docs have more detail?

I don't see Create/Add/Simulate Scroll(er) under UI Control or Layouts (only under All).

CreatePlayStore doesn't seem to be in Premium. Neither does CreateWizard

Add/Remove Layout/Drawer are on the Layout page and UI Control, 

but other objects/methods are on the Layout only.

Regards, ah

[Alan Hendry]

Hi,

Minor inconsistency

Example on https://symdstools.github.io/Docs/docs/app/CreateFile.htm has 

   file.WriteText( "Hello", "Chars" ); // note s on end of Chars

but tooltip on WriteText type has 

String: “UTF”, “Bytes” or “Char”

ReadText type also has 

String: “UTF”, “Line” or “Char”

And not sure I understand Writedata data tooltip

String: “FA,FB,FC” or “250,251,252” or “abc46”

Regards, ah

[Alan Hendry]

Hi,

When OnTouch for  CreateTEOutlineIconRight and  CreateTEOutlineIconLeft are added 

then they'd need documenting.

Regards, ah

[Angel Nganut]

hello please reply to my topic. i modify your script but not working. Thanks

[Alan Hendry]

Hi,

In the docs, CreateListDialog has an option "?" but there's no tooltip explaining what it does.

Two very minor points - 

ShowTip has only one option (Down) but the tooltip says "comma separated"

Similarly for ShowProgressBar (only option is "Light")

Regards, ah

[Alan Hendry]

Hi,

ShowCheckList has option "sun-moon" but no tooltip to explain it.

Regards, ah

[Alan Hendry]

HI,

Documentation of Layout has SetTextSize, should be SetChildTextSize

Regards, ah

[Alan Hendry]

HI,

https://symdstools.github.io/Docs/docs/app_ApplicationInformation.htm

has a link for IsThings

https://symdstools.github.io/Docs/docs/app/IsThings.htm

That gives a 404

Regards, ah

[Alan Hendry]

HI,

https://symdstools.github.io/Docs/docs/app/GetPermission.htm

has a popup for parameter type that has ExtSDCard twice

Not sure what quotes/apostrophes should be in usb parameter

String: comma “,” separated: “Camera” or “ExtSDcard” or “Network” or “Storage” or “Overlay” or “SMS” or “ExtSDcard” or “Location” or “Calendar” or “Body” or “Contacts” or “Record” or “Phone” or “Biometric” or “Accounts” or “License” or “usb:"<pid>"”

Regards, ah

[wheelie tips]

[Alan Hendry]

HI,

https://symdstools.github.io/Docs/docs/app/CreateCustomTabs.htm

has a link  plugin documentation that goes to 404 error

https://symdstools.github.io/Docs/docs/app/plugins/customTabs/CustomTabs.html

Also CreateTabs docs has option as NoArgins (only) but Example has VCenter

Regards, ah

[Steve Garman]

Re tabs:

   Fade and NoMargins are options used by the main tabs container

   but options are also passed to each tab

     app.CreateLayout( "Linear", "FillXY,"+options )

   so you can use anything that is compatible with a linear layout that makes sense

 

Fade may be still in beta, I'm not sure

[Alan Hendry]

HI,

Smart Edit doesn't recognize non-MUI tabs (neither tabs. nor tab1.).

And they don't cope with change of orientation very well.

Try starting the Basic Example in Portrait, then swap to Landscape (heading off top of screen);

or run in Landscape and rotate (left and right go off screen). 

I made tabs global, changed the second tab to tab2 and the third to tab3,

Added an OnConfig to SetSize for tabs (0.9) tab1/2/3 (0.8), somewhat better.

MUI TabFixed example doesn't rotate very well either.

Regards, ah

[Alan Hendry]

HI,

Minor typo on https://symdstools.github.io/Docs/docs/app/PlayRingtone.htm

Example - Play Notificatinop

https://symdstools.github.io/Docs/docs/app/CreateNotification.htm

SetOnNotify > callback > type pops up String: "Normal" or "?"

(Not sure if it actually returns a question mark, and what that would mean).

https://symdstools.github.io/Docs/docs/MUI/CreateDivider.htm

Example has "you can undone this process" (should be undo)

Regards, ah

[Alan Hendry]

HI,

Minor typo on Layout > SetOnChildChange pop-up has 

" Defines a callback function which is called when the content of a child control has beed changed by the user."

Should be "been"

Regards, ah

[wheelie tips]

docs>samples>

Icon Buttons

running sample crash:

"Script Error: Unexpected token 'break', Line 39, Icon_Buttons.js"

should add ";" at each case:

function btns_OnTouch()
{
    switch( this.icon )
    {
        case "[fa-undo]": edit.Undo(); break;

        case "[fa-repeat]": edit.Redo(); break;

        case "[fa-search]": alert("Todo!"); break;

       
        case "[fa-file]":
            edit.SetText( app.ReadFile( "/sdcard/testfile.txt" ) );
            break;
        case "[fa-save]":
            app.WriteFile( "/sdcard/testfile.txt", edit.GetText() ) ;
            break;
    }
}

[Alan Hendry]

HI,

https://symdstools.github.io/Docs/docs/app/SetOnBroadcast.htm 

has a link to a list of SDK 28 broadcast actions

For SDK 30 it should probably go to

https://developer.android.com/about/versions/11/reference/broadcast-intents-30

Regards

[wheelie tips]

CreateList>SetItemColor( title, newColor ) missing backClr as third parameter.

[Alan Hendry]

HI,

Could you add this somewhere (on the drawer open/close pages, and/or App Events)?

function OnDrawer( side, state )

state can be "Open" (when drawer is opened) or "Closed"

side can be "Left" or "Right"

Regards, ah

[Alan Hendry]

HI,

lst.SetColumnWidths doesn't seem to be in the docs

lst.SetDescription doesn't seem to be documented either.

Regards, ah

[Alan Hendry]

HI,

In the codeviewer app there's a line

      thisedt.SetSelection(pos, pos + sought.length)

But https://symdstools.github.io/Docs/docs/app/CreateTextEdit.htm

doesn't document SetSelection

The example BlueOnWhite on https://symdstools.github.io/Docs/docs/app/CreateTextEdit.htm includes

edt.SetTextColor( "#ff6666ff" );

which doesn't appear in the list of methods

Regards, ah

[Alan Hendry]

HI,

Minor typo on https://symdstools.github.io/Docs/docs/app/CreateTextEdit.htm

pop-up for SetCursorPos includes the "word" curernt (should be current)

Regards, ah

[Dave]

The docs describe card layouts as being like Linear layouts, but they are actually like Frame layouts.

[Frank Hoods]

beta forum link doesn't work

On Saturday, September 7, 2019 at 2:10:24 PM UTC+1 Symbroson wrote:

 Hi Folks,

I can finally announce that the DroidScript documentation is ready. Took me long enough.

This documentation is going to be included in one of the following beta releases - look forward to it :)

I have shared some more infos in the beta forum: https://groups.google.com/forum/#!topic/droidscriptbeta/CqpbNNp-IYQ

If you want to take a look please join the beta forum.

I specifically need some people to report any spelling mistakes, bad formulations, missing or even wrong information etc.

I'm also open for any feedback and/or further improvement suggestions.

Thanks in advance :)

[Alan Hendry]

HI,

You have to ask for access to the  Beta Forum 

Send an email to sup...@droidscript.org

support[at]droidscript[dot]org requesting an invitation to the beta forum

(2.50 has gone live today)

Regards, ah

[Symbroson]

Hi folks,

I finally updated the docs and hopefully addressed all the issues posted here.

Please keep up reporting docs issues and suggestions here as it helps out a ton!

Theres a new section with best practices in the introduction which also addresses performance points made in previous posts

thanks and best regards,

Alex

[Alan Hendry]

HI,

For Best  Practices ...

I frequently use SetChildMargins and SetChildTextSize on a Layout 

to avoid doing it for every control (directly) inside the Layout.

Before disabling debug and creating the production release, 

it's a good idea to check if debug shows any errors 

(either by touching  the bug icon, or looking at the WiFi IDE debug window).

cfg.Node seems to speed up MUI lists.

Regards, ah

[Alan Hendry]

HI,

Minor typo "becuase" on

https://symdstools.github.io/Docs/docs/intro/08BestPractices.htm

If an app has mainly black  backgrounds and/or white text then cfg.Dark,

or conversely cfg.Light.

(I see that lay.setChildMargins/TextSize are already mentioned, 

not sure if I missed them, or it's already been modified).

Thanks, ah

[Alan Hendry]

HI,

25 Mar 2021, 08:12:42 There was a post

I discovered that the actual syntax for the Create list command is:
        app.CreateList(list,width, height, options, delimiter)

Doesn't seem to been altered on

https://symdstools.github.io/Docs/docs/app/CreateList.htm

14 Oct 2020, 14:10:34 There was a post (among others)

that seems to use an array on  CreateList (may also apply to AddList and lst.SetList), 

var Name = ['Jhon', ...,'James']; 

...

 lst = app.CreateList( Name, -1, -1,"Center"); 

Regards, ah

[Alan Hendry]

HI,

Might be an idea to add notes for the best practice in reporting problems

(be clear / specific, include some code, add a screenshot, version of DS and Android)

Regards, ah

[Alan Hendry]

HI,

A warning to avoid arrow functions could avoid problems for users who build their app with obfuscate.

app.GetOptions is documented as possibly returning Game and noDom (not sure if the latter is x-version)

Does it have other values from cfg statements? (MUI, Node, Dark, Light, ...).

Regards, ah

[Steve Garman]

As far as I know arrow functions are no longer a problem for the obfuscator

However the advice is to not use them for callback s, especially if they may require the this keyword

[Alan Hendry]

HI,

If a user uninstalls DS then Android 10+ will delete all their projects/apps.

As well as suggesting backups

you could advise them to install fixes and new versions "on top of" their current version

(and not uninstall DS).

Regards, ah