Offline documentations

Juliano David Hilario

2 Oct 2023 2 Oct '23

1:59 a.m.

Is there a way to view the documentations offline? Sort of the way the Python docs work, where you could just search for a subject and it will function regardless of internet connection. If it's not yet working, I could contribute some of my time if it's not that a heavy of a task. Something like this would be convient, since some like to search by topic. Though since we probably have the common ground of liking writing, we, or most of us, prefer referring to current manuals out there.

Attachments:

attachment.html (text/html — 604 bytes)

Show replies by thread

Henning Hraban Ramm

2 Oct 2 Oct

2:24 a.m.

Am 02.10.23 um 09:59 schrieb Juliano David Hilario:

...

Is there a way to view the documentations offline? Sort of the way the Python docs work, where you could just search for a subject and it will function regardless of internet connection. If it's not yet working, I could contribute some of my time if it's not that a heavy of a task. Something like this would be convient, since some like to search by topic. Though since we probably have the common ground of liking writing, we, or most of us, prefer referring to current manuals out there.

Well, the documentation is spread over several PDF files, and the wiki is not usable offline, of course. You can grep through the sources of the manuals (in texmf-context/doc/context/sources). And there is a command reference browser: mtxrun --script server --auto and the open http://localhost:8088/mtx-server-ctx-help.lua But since it just shows what’s in the interface files, it lacks any explanations. Hraban

Juliano David Hilario

2:32 a.m.

If I were to download the entire wiki with the exception of the discussion files and the user pages, do you think it would be wise? I would try to make it dynamically updatable too, if possible, and also try to make as offline-friendly as the Python docs. Do you think that would be wise? Thank you for your help, the wiki is very useful. On Mon, Oct 2, 2023, 4:29 PM Henning Hraban Ramm wrote:

...

...
Is there a way to view the documentations offline? Sort of the way the Python docs work, where you could just search for a subject and it will function regardless of internet connection. If it's not yet working, I could contribute some of my time if it's not that a heavy of a task. Something like this would be convient, since some like to search by topic. Though since we probably have the common ground of liking writing, we, or most of us, prefer referring to current manuals out

Am 02.10.23 um 09:59 schrieb Juliano David Hilario: there.

Well, the documentation is spread over several PDF files, and the wiki is not usable offline, of course.

You can grep through the sources of the manuals (in texmf-context/doc/context/sources).

And there is a command reference browser:

mtxrun --script server --auto

and the open http://localhost:8088/mtx-server-ctx-help.lua

But since it just shows what’s in the interface files, it lacks any explanations.

Hraban

___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context webpage : https://www.pragma-ade.nl / http://context.aanhet.net archive : https://bitbucket.org/phg/context-mirror/commits/ wiki : https://contextgarden.net

___________________________________________________________________________________

Juliano David Hilario

2:37 a.m.

Also, if I were to do that, I might just make at the moment some sort of search engine, or grep it when I need something, then view whatever I need in the wiki. I'm just wondering if it's fine if I were to send many GET requests and obtain a copy of the wiki. Would that act like a DDoS attack? On Mon, Oct 2, 2023, 4:32 PM Juliano David Hilario < yellowcutterpillow@gmail.com> wrote:

...

If I were to download the entire wiki with the exception of the discussion files and the user pages, do you think it would be wise? I would try to make it dynamically updatable too, if possible, and also try to make as offline-friendly as the Python docs. Do you think that would be wise? Thank you for your help, the wiki is very useful.

On Mon, Oct 2, 2023, 4:29 PM Henning Hraban Ramm wrote:

...
...
Is there a way to view the documentations offline? Sort of the way the Python docs work, where you could just search for a subject and it will function regardless of internet connection. If it's not yet working, I could contribute some of my time if it's not that a heavy of a task. Something like this would be convient, since some like to search by topic. Though since we probably have the common ground of liking writing, we, or most of us, prefer referring to current manuals out

Am 02.10.23 um 09:59 schrieb Juliano David Hilario: there.

Well, the documentation is spread over several PDF files, and the wiki is not usable offline, of course.

You can grep through the sources of the manuals (in texmf-context/doc/context/sources).

And there is a command reference browser:

mtxrun --script server --auto

and the open http://localhost:8088/mtx-server-ctx-help.lua

But since it just shows what’s in the interface files, it lacks any explanations.

Hraban

___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context webpage : https://www.pragma-ade.nl / http://context.aanhet.net archive : https://bitbucket.org/phg/context-mirror/commits/ wiki : https://contextgarden.net

___________________________________________________________________________________

Henning Hraban Ramm

2:47 a.m.

Am 02.10.23 um 10:32 schrieb Juliano David Hilario:

...

If I were to download the entire wiki with the exception of the discussion files and the user pages, do you think it would be wise? I would try to make it dynamically updatable too, if possible, and also try to make as offline-friendly as the Python docs. Do you think that would be wise? Thank you for your help, the wiki is very useful.

I don’t know if it’s wise. It’s a MediaWiki, there are solutions around, e.g.: https://www.mediawiki.org/wiki/Exporting_all_the_files_of_a_wiki https://github.com/WikiTeam/wikiteam One is even built-in: https://wiki.contextgarden.net/Special:Export (you would need a local MediaWiki instance a import the pages there). See also https://www.mediawiki.org/wiki/Help:Export You can also use curl to recursively download all contents of a website. Hraban

Henning Hraban Ramm

2:55 a.m.

Am 02.10.23 um 10:37 schrieb Juliano David Hilario:

...

Also, if I were to do that, I might just make at the moment some sort of search engine, or grep it when I need something, then view whatever I need in the wiki. I'm just wondering if it's fine if I were to send many GET requests and obtain a copy of the wiki. Would that act like a DDoS attack?

For a DDoS attack you’d need more (for one, it’s not distributed, so at most DoS). I assume it should be ok if you don’t do it too often (like hourly). And of course you’re expected to report wrong/outdated information and to help with updating it. Hraban

Thomas A. Schmitz

2:57 a.m.

On 02.10.23 10:32, Juliano David Hilario wrote:

...

If I were to download the entire wiki with the exception of the discussion files and the user pages, do you think it would be wise? I would try to make it dynamically updatable too, if possible, and also try to make as offline-friendly as the Python docs. Do you think that would be wise? Thank you for your help, the wiki is very useful.

That doesn't answer your question if it would be wise, but if you manage to write a script that would create an archive of the wiki in a useful format for off-line browsing and keep it reasonably up to date, that would be a wonderful thing to have. I regularly find myself in situations where I don't have internet access and would love to have a look at the wiki. On the other hand: there is a lot of cruft on the wiki, badly outdated pages that relate to mkii etc. But selecting the ones that are good and getting rid of the others would be a huge amount of work... Thomas

Hans van der Meer

3:07 a.m.

I find offline documentation in the installed ConteXt files in ConTeXt/tex/texmf-context/doc/context/documents/general/manuals with more in neighboring directories. Hope this helps. met vriendelijke groet, dr. Hans van der Meer Burgemeester Rijnderslaan 244 ingang D 1185 MC Amstelveen tel. 020 6452701 / 06 53743629

...

On 2 Oct 2023, at 10:55, Henning Hraban Ramm wrote:

__________________________________________

Juliano David Hilario

9:57 a.m.

@Thomas I think so too, Thanks Hans, I'll take a look at it! On Mon, Oct 2, 2023, 5:15 PM Hans van der Meer via ntg-context < ntg-context@ntg.nl> wrote:

...

I find offline documentation in the installed ConteXt files in ConTeXt/tex/texmf-context/doc/context/documents/general/manuals with more in neighboring directories. Hope this helps.

met vriendelijke groet, dr. Hans van der Meer Burgemeester Rijnderslaan 244 ingang D 1185 MC Amstelveen tel. 020 6452701 / 06 53743629

On 2 Oct 2023, at 10:55, Henning Hraban Ramm wrote:

__________________________________________

___________________________________________________________________________________ If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://www.ntg.nl/mailman/listinfo/ntg-context webpage : https://www.pragma-ade.nl / http://context.aanhet.net archive : https://bitbucket.org/phg/context-mirror/commits/ wiki : https://contextgarden.net

___________________________________________________________________________________

298

Age (days ago)

298

Last active (days ago)

List overview

Download

8 comments

4 participants

participants (4)

Hans van der Meer
Henning Hraban Ramm
Juliano David Hilario
Thomas A. Schmitz

Offline documentations

tags

participants (4)