Update documentation for new matrix defintion

[goyalyashpal]

Complementary to https://github.com/mkulesh/microMathematics/issues/108

[goyalyashpal]

i'd like to work on this with some assistance, guidance and feedback

[mkulesh]

Hi @yashpalgoyal1304, the simplest way just get the latest PDF (https://github.com/mkulesh/microMathematics/blob/supplement/doc/microMathematics-v2.22.0.pdf), and send me a text document that contain changes with respect to this PDF. I will than include it into the App documentation and generate new PDFs. Alternatively, if you have LaTeX installed, just expand the file https://github.com/mkulesh/microMathematics/blob/master/doc/how_to_use.tex and attach it here (do not open a pull request since this file is auto-generated). I will than merge these changes into the app documentation.

[goyalyashpal]

Progress report:

• Pasting the link for my own reference docs.google...viewer...raw

• Seems there's no way to clone only a subdirectory in git :( aaaah, git is always a headache :(

• Due to above point, only ↓-loaded 4 files ∴'ve removed code containing \input & \includegraphics

  • how_to_use.tex
  • microMathematics.tex
  • microMathematics.sty
  • versionCode.sty

• Now i am getting a fatal error in pdflatex compilation :(

  how_to_use.tex:95: pdfTeX error (font expansion): auto expansion is only possible with scalable fonts.
  pdflatex: major issue: So far, no MiKTeX administrator has checked for updates.
  <argument> ...shipout:D \box_use:N \l_shipout_box
                                                \__shipout_drop_firstpage_...
  l.95
  how_to_use.tex:95:  ==> Fatal error occurred, no output PDF file produced!

• I will only make changes to source 😢 without worrying about compilation and end result

• Adding \usepackage{lmodern} as a newline at microMathematics.sty:4:0 worked. Refer StackExchange Answer

• Oh yeah, i was not and still am not able to find EDIT: ohkay, this is not delivered with app, rather available in this repo at README.md#documentation

  The document ”units_overview.mmt” contains the list of all supported units. This document is delivered with the app and stored in ”Resurces of microMath-ematicsPlus” The document "functions_overview.mmt", stored within the ''Resources of microMathematic Plus'', provides the list of all available functions.

[goyalyashpal]

Github is not allowing uploading .tex files.

So, i'll open that pull request as a medium to share the .tex file.

I hope it's ohkay with you :innocent:

	,tex (source)	.pdf (rendered)
Original	original-src	original-pdf
Suggestion	suggestion-src	suggestion-pdf

[goyalyashpal]

here's the place where you can see the .tex file i made: https://github.com/mkulesh/microMathematics/pull/117

[mkulesh]

Hi @yashpalgoyal1304, thank you for providing the updates. I will merge it within the next couple of days...

[goyalyashpal]

Though i think the suggestions should be good, but be sure to check these for aptness and errors from your side them as well. :innocent:

[mkulesh]

Hi @yashpalgoyal1304, I successfully merged your updates and applied some minor changes. Please note that from the technical reason I shall have the same order of images across all translations, therefore I reverted one update related to the image order change. Could you please build the app and pdf and review whether the changes in build-in app documentation and pdf are as desired?

[goyalyashpal]

Hey!

• Building the pdf: yeah, i will do that.
• Building app: I dont have much xp, but i will try.
• Though i will try building app, but asking for curiousity, will it suffice if rather than building app, I just open the new .mmt file in the existing app?

Mikhail Kulesh wrote:

Could you please build the app and pdf and review whether the changes in build-in app documentation and pdf are as desired?

[mkulesh]

Hi, I also uploaded the APK here: https://github.com/mkulesh/microMathematics/raw/autobuild/autobuild/microMathematics-v2.22.0-release.apk

You can just download and install it. Depending on the store where you installed the actual version, you may need to uninstall it before this new build can be installed.

You do not need to open any .mm file, just select "How To Use" from the navigation menu and new text shall appear.

In order to build the app manually, you need Android Studio installed, please take a look on this document: https://android-doc.github.io/sdk/installing/index.html?pkg=studio

After Android Studio is installed, you can just open the project, build it, and install either in an emulator, or on your phone. Before it, please ensure that the developer mode is activated on your phone: https://developer.android.com/studio/debug/dev-options

[goyalyashpal]

yes, 3 things require attention

r[0 := 5 r[3 := 6 r[2,0 := -4

1. This is kinda illegal. The first two equations with 1D index are not taking affect, and rightly so, since as per the following third equation, r is a 2D array.

This document is also delivered with the app and stored in "Resources of microMathematics Plus".

2. Where can those documents (units_overview.mmt , functions_overview.mmt) be found from within app?

3. Related question to the second: On first running the app, a guiding document opens up. Where can that be found from within app if user wants to re-read that as a short refresher.

Mikhail Kulesh wrote:

Could you please build the app and pdf and review whether the changes in build-in app documentation and pdf are as desired?

[goyalyashpal]

oh wait, i re-tested. and it is legal. The element r[ ] is different from r[ , _ ]. Both are executing and giving expected values.

Earlier, I thought they would conflict with each other, and confirmation bias made me test it only with 2 arguments.

Yash wrote:

r[0 := 5 r[3 := 6 r[2,0 := -4

1. This is kinda illegal. The first two equations with 1D index are not taking affect, and rightly so, since as per the following third equation, r is a 2D array.

[mkulesh]

Hi @yashpalgoyal1304,

please feel free to update the example formula if you mean my variant is not consistent. units_overview.mmt and functions_overview.mmt stored in the resources of the app: app menu -> Open file -> Home Button -> Resources of "microMathematics":

The same case is the "welcome" document that is shown on the first run of the app. It is also placed in the resources of the app, but in the language-dependent sub-directory, for example doc_en for English. The file name is "welcome.mmt". Other files are the items (documents) presented in the app navigation menu.

If you have any changes, please open the pull request with updated .tex file as before.

[mkulesh]

Scheduled for release 2.22.1

[mkulesh]

Released in version 2.22.1

[goyalyashpal]

yes, 3 things require attention

r[0 := 5 r[3 := 6 r[2,0 := -4

1. This is kinda illegal. The first two equations with 1D index are not taking affect, and rightly so, since as per the following third equation, r is a 2D array.

This document is also delivered with the app and stored in "Resources of microMathematics Plus".

2. Where can those documents (units_overview.mmt , functions_overview.mmt) be found from within app?

3. Related question to the second: On first running the app, a guiding document opens up. Where can that be found from within app if user wants to re-read that as a short refresher.

Mikhail Kulesh wrote:

Could you please build the app and pdf and review whether the changes in build-in app documentation and pdf are as desired?

[mkulesh]

Hi @yashpalgoyal1304,

you are right, r[0 := 5 r[3 := 6 r[2,0 := -4 is a little bit confusing. I see two options:

1. I can just correct the documentation (do not mix one- and two-dimensional arrays in the same variable), but keep this functionality in the code
2. I also can include a check, that the mix one- and two-dimensional arrays in the same variable is not allowed.

That option is the best from your point of view?

The units_overview.mmt and functions_overview.mmt are stored in the "Resources of microMathematics Plus". To navigate, open app menu, than menu "Open", that press Home button in the file selection dialog, and, finally, select "Resources of microMathematics Plus". You will see units_overview.mmt, functions_overview.mmt and other documents. If you than selects a language, for example "doc_en", you will also find "welcome.mmt" document that is a a guiding document when the app is started the first time.

[goyalyashpal]

• I did not send any reply via email 5 days ago whatsoever
• this above comment is a duplicate of one of my previous comment : https://github.com/mkulesh/microMathematics/issues/112#issuecomment-1100220903.
• i don't know what is happening
• please help me stop this :cry:

Other similar comments sent same "5 days ago" - which i am sure i didn't send in such recent time

• https://github.com/florisboard/florisboard/issues/1882#issuecomment-1274881164
• https://github.com/mkulesh/microMathematics/issues/112#issuecomment-1274212650
• https://github.com/JuliaPlots/Plots.jl/issues/4311#issuecomment-1274364015
• https://github.com/geany/geany/issues/3146#issuecomment-1274237581

On Sunday, October 16, 2022, Mikhail Kulesh @.***> wrote:

Hi @yashpalgoyal1304 ,

you are right, r[0 := 5 r[3 := 6 r[2,0 := -4 is a little bit confusing. I see two options:

1. I can just correct the documentation (do not mix one- and two-dimensional arrays in the same variable), but keep this functionality in the code
2. I also can include a check, that the mix one- and two-dimensional arrays in the same variable is not allowed.

That option is the best from your point of view?

The units_overview.mmt and functions_overview.mmt are stored in the "Resources of microMathematics Plus". To navigate, open app menu, than menu "Open", that press Home button in the file selection dialog, and, finally, select "Resources of microMathematics Plus". You will see units_overview.mmt, functions_overview.mmt and other documents. If you than selects a language, for example "doc_en", you will also find "welcome.mmt" document that is a a guiding document when the app is started the first time.

—

[goyalyashpal]

as for the main topic question at hand:

1. I can just correct the documentation (do not mix one- and two-dimensional arrays in the same variable), but keep this functionality in the code

this one seems better imo, as i don't understand the matter in proper depth have not much experience with it

[mkulesh]

Hi @yashpalgoyal1304, I also have no idea why some your messages are duplicated. I fixed the documentation: do not mix one- and two-dimensional arrays in the same variable. Now it looks like this:

If you like to test the latest development build, please manually download and install this APK: https://1drv.ms/u/s!At2sh2-YDyGFgSS5KwhWlWDZD4LS?e=tBD0u4

[goyalyashpal]

hi! i couldn't spot any such notice for "do not mix" in documentation: neither in above screenshot, nor in the commit. can u recheck??

[mkulesh]

Hi @yashpalgoyal1304 with "do not mix" in documentation I mean do not demonstrate any examples that use one- and two-dimensional indices for the same variable. In new example, r1 is one-dimensional variable and r2 is two-dimensional. If you think we shall explicit write that the user shall not use mixed indices in their own worksheets, please fell free to update https://github.com/mkulesh/microMathematics/blob/master/doc/how_to_use.tex accordingly and I will merge these changes into the internal documentation.