#4414 (site features need no translatable text)

by Luc Saffre · in Developers · assigned to Luc Saffre

Summary

Children

Comments

4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : I committed my changes. Book test suite passed on my machine. In welfare there is still one doctest failing because of that side effect...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : The ovfields test case was not "neutered", it just had become useless because the issue is fixed since Django 4. But this meant that there was a useless test still being done in kernel. Which I now removed. The ovfields test also shows another side effect, which is also in docs/specs/welcht/chatelet...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : I am still having a side effect in docs/dev/ovfields/index.rst, and looking at it I realize that this test case has been neutered: it is no longer testing the thing it had been written for.
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : Yes, we're going to throw away the lino.core.features module, and SITE.features is a simple AttrDict containing either True or False for each available feature. The features module was mostly Sharifs work, and I would probably feel frustrated in his place now. That's why I insist on saying: Sharif d...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : I am confident that my drastic simplification will work. But the test suite is still running. inv prep in book failed during the first run because I renamed Site.activate_feature() to Site.enable_feature(). That's the price of being perfectionist...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : I didn't understand why the priority kwarg was needed. (Google plugin used it with value 1000).
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : And I will even do this now. Because the other problem of the global LINO_FEATURES is also visible.
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : Aha. "getlino list" already instantiated the Site classes found in each settings modules. So that's possible. But cannot startup() them because that would cause the Django machine to start up. And therefor it also cannot use the descriptions, because these are translatable texts: the mere fact of co...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : The dict with site features is currently being stored in a global object LINO_FEATURES. This won't work when we want to generate the features docs for all applications known by getlino because in that case each application will instantiate a SITE on her own. I am not sure whether this will be feasib...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : If get help_text_extractor to also extract the text under a `setting` directive, then we should probably remove the description string from the source code. Or maybe rename it to help_text. Remember that these texts need to get translated. And they are like help texts.
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : Before discussing about this, we should see the end-user documentation that can be generated automatically. I meanwhile think that it should *not* be in the local help pages but rather in the application docs. But it is possible that application docs are actually the local help pages for the applica...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : It is even possible that I am changing once more my mind about whether the description text in the source code makes sense.
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : Even after our yesterday brainstorming with Sharif I still have no answer regarding how exactly to organize the documentation about site features. We currently still have two (redundant) documentation pages about the settings.py file in the hosting guide: [url hosting.lino-framework.org/settings/] a...
4 years, 5 months ago by Luc Saffre about #4414 (site features need no translatable text) : Sharif and I had another brainstorming because this ticket didn't advance. See [url luc.lino-framework.org/blog/2022/0522.html my blog]. Indeed the plan I wrote 4 months ago wasn't good.
4 years, 9 months ago by Luc Saffre about #4414 (site features need no translatable text) : I wrote documentation about [url dev.lino-framework.org/specs/users.html#feature-third_party_authentication third_party_authentication] as an example of a feature URL. This is only a first draft of where to document them. Anyway the basic point is that there should be an URL for every feature. I add...
4 years, 9 months ago by Luc Saffre about #4414 (site features need no translatable text) : I added a new directive/role pair "feature" in lino.sphinxcontrib.base because theoretically we might have a Site class attribute and a feature of same name (but with different meanings).
4 years, 9 months ago by Luc Saffre about #4414 (site features need no translatable text) : Good question: where (and how) to document features. For the site maintainer they are a bit like local site settings because they are defined in the setings.py file. OTOH they should not get mixed up with Site attributes or Plugin attributes.
4 years, 9 months ago by Luc Saffre about #4414 (site features need no translatable text) : But an url instead of the text. And let's talk about how to show them in the about window.