Edit of 4 July 2016::

Because of the need to have a lasting storage place the file for local docs is now located at:
http://kmeleonbrowser.org/forum/read.php?9,139183,139183#msg-139183

My dropbox account no longer functions.

- - - - - - - - - - - - -

This thread is for discussion and collaboration on producing some documentation for K-Meleon which a user may run locally.

Some documentation is complete, but only in English.
2014-08-25 https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z
note: This version installs in K-Meleon 74

Edit # 1 2014-08-26 ( Updated in place - use original link )

Changes  - Revised icon background
           Removed the 990px body width
           Moved icon closer to header
           Changed header width to 88%

Edit # 2 3014-12-05 ( Updated in place - use original link )

Changes  - Spanish translation for menu added
           Revised Command IDs to include Command Names
           Revised MacroLanguage id() for Command Names

I hope to add any updates to this post using edits.



Edited 3 time(s). Last edit at 07/04/2016 04:57PM by JamesD.

@ siria

I have just remembered that I have my easeread macro running so that all pages that I load have a text zoom times two applied. I will have to keep that in mind when we discuss horizonal scroll bars.

I am running a 1024 x 768 display. Most of the documentation displays within the viewing area without scrolling. Some items require scroll bars even when I zoom out text 2 times. There does not seem to be a way to break up a single line of example code or code description and still convey to the user that it is one long line.

I removed the width 990px statement and fixed the spelling in the current code.

Thanks - it's nice to have some local help files, always missed that

It really looks like the header causes the scrollbar, even when all body lines are much shorter, like in the ID list. All pages (except desgas list and plugins) are equally about 10% too wide, causing a scrollbar at the bottom. Can only be that the header with its width of 100% plus 2x5% for the borders causes this. But if the header width is set to 85-90% the page width is okay and the scrollbar disappears.
The only exception is the plugins page because of the extra long code lines, but that's a lesser prob, since the text before and after this code shows with the normal 110% width again.



Edited 1 time(s). Last edit at 08/25/2014 07:45PM by siria.

@ siria

Here is a replacement css file. I think I included the old one before.


https://dl.dropboxusercontent.com/u/1522294/KDocs.css

Edit # 1 2014-08-26 ( Updated in place - use original link )
Changes - Revised icon background
Removed the 990px body width
Moved icon closer to header
Changed header width to 88%

https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z

@ siria

Should I attempt to edit the Quick Reference by desga2 to remove the history plugin or just insert a note that is not included in KM 74?

What version of KM can you run with your Win98SE? This can be made to run there with a new placement of localdocs folder and different macro.



Edited 1 time(s). Last edit at 08/26/2014 08:23PM by JamesD.

Works quite nicely now!

Am just afraid KM74 has quite some differences to older versions and for the time being that train is racing on without me. So am rather clueless and cannot tell much about such details like history. Just thinking, perhaps it would still be easier to maintain a universal multi-version macro with a note here and there, as two completely separated macros? Considering how outdated the wiki is, the contents of the files themselves could take a long time until everything is fully updated to KM74, if ever, so why.

And of course, coding myself a bit, tiny adjustments like a folder path are no work but fun Actually, because of the fun, couldn't resist streamlining the code a bit my usual way, no fundamental changes, just gets easier to read.
And renamed the menu entry to 'Manual (macro LocalDocs)', because "if" I were a clueless user I would suspect "Local Documents" were somehow for user documents, like in Windows "my documents" directory, because it's a very unfamiliar name for manual/help files (to me anyway, don't know about developers).
But decided to keep the new 74 path for browser-res anyway, because it doesn't harm and makes multi-version macros easier.

You know what would be handy? To have all manual pages listed as a links row under the header.... but then again, it's just a gimmick.



Edited 1 time(s). Last edit at 08/26/2014 10:54PM by siria.

I have made changes in MacroLanguage and Command IDs to include the "command name" alternate identification for Command Ids.

I also now have a Spanish translation for the menu.

https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z

Hi, James!

I've edited russian translation file for your great LocalDocs, so you can add it to next release of this macro!

Thank you for all your efforts!

@ rodocop

Thanks for your work. I am on holiday this month, but I will get the new file added as soon as I get back home.

@ rodocop

I have finally gotten the new RU translation installed. Please check and see if I did it correctly.

Thank you for providing the update.

https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z



Edited 1 time(s). Last edit at 03/06/2015 03:02PM by JamesD.

James,
and finally I found time to try new LocalDocs: all is done fine for ru-locale! Thank you!



Edited 1 time(s). Last edit at 03/15/2015 10:55AM by rodocop.

It is curious whether is possible to create LocalDocs in the same way, like our site wiki - so that they'll consist of some different language translations and the shown one was defined by KM-locale set up?

Does anyone have a thought?

I want to translate some docs like commands.html, but it isn't right way to 'hardcode' them in particular lang.

Would be very K-Meleonyyyy to get possibility choose right language version according to browser current locale (like readme is chosen)

Pheeeew... way too much work, rodo
And the main prob is to keep all versions up-to-date, that's impossible. The wiki is rather outdated even in english, but the other languages are usually even some more years outdated, really bad! And readers aren't even aware of that.

For localdocs, just as for the wiki, every webpage must be duplicated and fully translated in one piece. It's an independant site with another link target. There is no such thing as only partial translations, like with menu names etc. in kml.

If you make now a RU version of commands.html, that's fine, and a macro can sure check the browser locale and change the link accordingly. But probably it will soon be outdated, and who has the time to always keep things up-to-date? Even in english, with all those folks around, it's still hopeless...

I'll make this anyway for someday ;-)

Let's try to start.
I think commands.html can be added to locale like readme-file - for autochoosing. Or maybe simply create local package of relatively linked pages for different language and make it select lang reading browser locale like some websites do?

Or just manually - clicking on flag icons? Like here, for example:





Edited 2 time(s). Last edit at 04/11/2015 09:54PM by rodocop.

There are several ways this can happen. As siria said they become outdated quickly.

Do you happen to know which is the most current version? I ask that because there at least two available. One is by desga and I have that in local documents. The other comes with KM and is found as "Commands List" under EDIT - CONFIGURATION.

If you do a translation of the one in Local Documents, then all you have to do is name your file "ruQuickReference.htm" and place it in the same folder as "QuickReference.htm".

Then you would need to change the localdocs74.kmm file to provide an if-then selection for choosing which file goes into the variable "$OpenURL".

_localdocs_KMQuickReference {
macroinfo=_("View Desga's Quick Reference Guide");
$OpenURL="file:///" .$_localdocs_res . "/localdocs/QuickReference.htm";
&OpenURL_InNew;
}

A more difficult method would be to change the version in Configuration to an XHTML file with entities and provide entity tables for each language. That, I think, is the standard way it is done in KM.

I will be glad to help with any part EXCEPT the translation.

Love handy localdocs macro, use it for looking syntax up all the time

But the description of some macro commands is so techy that it's difficult
to understand without practical examples, at least for us non-dev users ;-)
Let's add perhaps something like that or similar?

$SUB = substr( s, i [, n] );

Returns the at most n-character substring of s starting at i. If n is omitted, the rest of s is used:
live">extract=substring(from this text, begin position, optional max length);
Example: $_x=($URL,37,2);

Quote
siria
But the description of some macro commands is so techy that it's difficult
to understand without practical examples, at least for us non-dev users ;-)
Let's add perhaps something like that or similar?

Send me a list of the statements which most need examples. I will see what I can do.

Shall I add the examples to macrolanguage2 in wiki also?

Just assuming, the wiki page is much the same as localdocs? Because I'm afraid if they are drifting apart it could get rather confusing to keep both up-to-date, therefore posted it first here, not directly edited myself ;-)
Would like to edit but am too short on time currently, should do 100 other things first, so can only do a bit here and there, sigh...

siria

Here is some code for localdocs > macrolanguage. Do you think I should continue work in this style. I would not use <crlf> but the correct HTML tag is not allowed in the forum.

 <div id ="substr()">
<pre>
<strong>    $SUB = substr( s, i [, n] ); </strong>                                              <small>Since version 0.7</small>
</pre>
Returns the at most n-character substring of s starting at i. If n is omitted, the rest of s is used.
<samp>
<h4>Examples</h4>
$_orig = "abcdefghijkl";  $_len = 4 ;  $_start = 3 ; <crlf>
$_part = substr( $_orig, $_start, $_len ) ;   $_part becomes "defg". <crlf>
$_rest = substr( $_orig, $_start ) ;  $_rest becomes "defghijkl".
</samp>
</div>

The page for MacroLanguage in Local Documents has been updated to reflect the changes and additions for K-Meleon 75.0.

If you only need the update then get:
https://dl.dropboxusercontent.com/u/1522294/LocDoc-update-15_07_12.7z

If you need the complete Local Documents then get:
https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z

Functions added:
addbutton()
addperm()
addtoolbar()
checkbutton()
enablebutton()
fileexists()
killtimer()
logmsg()
popupmenu()
removebutton()
setbuttonimg()
setcmdicon()
settimer()
time()

Global Variable added:
$VERSION

Some functions in "String Handling" now include example code as an experiment. Comments on this are welcome.

(just trying to collect new stuff 'somewhere')

New macro functions in KM75.1:

http://kmeleonbrowser.org/forum/read.php?8,134648,134766#msg-134766

Quote
Dorian
- Added: allow function declaration in macros, some main macros are now function, compat75 assure compatibility with older macros

(....)
Examples:

MyMacro{
_urlbarcolorcompute(10,20,50);
}

function add1($v) {
return $v+1;
}
MyMacro{
$arg1 = add1($ARG);
alert($ARG."+1=".$arg1);
}

siria

I have a working macro with function.

http://kmeleonbrowser.org/forum/read.php?8,134648,134808#msg-134808

The macrolanguage.htm file in local documents has been updated to the same level as the wiki for K-Meleon 75.1

If you already have the localdoc74 you can use this update:
https://dl.dropboxusercontent.com/u/1522294/LocDoc-update-15_10_01.7z

If you need the complete local documents system, then get this:
https://dl.dropboxusercontent.com/u/1522294/LocalDocs74.7z

Two new sections:
Interface to:  The File System
               The Network

The fileexists() statement is moved from the operating system section to the 
file system section. It is joined by the appendfile(), copyfile(), 
deletefile(), mkdir(), renamefile(), and writefile() statements.

The pluginexist() statement is added to the K-Meleon plugins section.

The date() statement is added to the operating system section.

The download() statement is added to the network section.

Looks like Desga, nor me (nor anyone else), reviewed the KML file:

# ---------- Local Documents ------------ es-ES --------------------------

View information on the K-Meleon MacroLanguage=Ver información sobre el lenguaje de Macros de K-Meleon
View information on the K-Meleon Command Line Options=Ver información sobre las opciones de línea de comandos de K-Meleon
View information on the K-Meleon Plugin Commands=Ver información sobre los comandos para los Plugin de K-Meleon
View information on the K-Meleon Command IDs=Ver información sobre los comandos ID_ de K-Meleon
View information on the K-Meleon Macro Guidelines=Ver información sobre el uso del lenguaje de Macros de K-Meleon
View Desga's Quick Reference Guide=Guía rápida de referencia por Desga
Local Documents=Documentos locales
K-Meleon MacroLanguage=Lenguaje de Macro de K-Meleon
K-Meleon Command Line Options=Opciones de línea de comandos de K-Meleon
K-Meleon Plugin Commands=Comandos para los plugins de K-Meleon
K-Meleon Command IDs=Comandos ID_ de K-Meleon
K-Meleon Macro Guidelines=Manual del lenguaje de Macros de K-meleon
K-Meleon Quick Reference=Referencia rápida de K-Meleon
View information on K-Meleon Cookie Management=Ver información sobre la gestión de cookies en K-Meleon
K-Meleon Cookie Management=Gestión de cookies de K-Meleon

JohnHell

Quite possible that I only did translation from an online source. That is almost always 'not exactly right'.

Hello

chmreader enables opening and viewing local chm helpfiles directly into kmeleon.



Edited 1 time(s). Last edit at 04/22/2018 07:56AM by JujuLand.