Media Wiki

Keep up to date with EG related information here.

Re: Media Wiki

Postby pearbear » Mon Jun 12, 2017 12:03 pm

Why can't translations be added in the docstrings?
pearbear
Experienced User
 
Posts: 150
Joined: Mon Apr 02, 2012 10:28 pm

Re: Media Wiki

Postby kgschlosser » Mon Jun 12, 2017 3:53 pm

we don't want to congest the code.

example

Code: Select all
class WindowsVersion:
    """
    A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php
    """


can you imagine having that docsting repeated for 10 different languages?

Code: Select all
class WindowsVersion:
    """
    A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

    A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

A convenience module for checking the windows version.

    In addition to the *IsXY()* methods, you can use comparison like this:

    ``eg.WindowsVersion OPERATOR "KEY"``

    ``OPERATOR`` is one of ``<``, ``<=``, ``==``, ``!=``, ``>=``, ``>``

    +-----------+--------------------------------------+
    | ``KEY``   | Windows version(s)                   |
    +===========+======================================+
    | ``XP``    | *all of XP32 and XP64*               |
    +-----------+--------------------------------------+
    | ``XP32``  | Windows XP,                          |
    |           | Windows XP 64-Bit Edition,           |
    |           | Windows Tablet PC,                   |
    |           | Windows Media Center Edition 2002,   |
    |           | Windows Media Center Edition 2004,   |
    |           | Windows Media Center Edition 2005    |
    +-----------+--------------------------------------+
    | ``XP64``  | Windows XP Professional x64 Edition, |
    |           | Windows Server 2003,                 |
    |           | Windows Server 2003 R2               |
    +-----------+--------------------------------------+
    | ``Vista`` | Windows Vista,                       |
    |           | Windows Server 2008                  |
    +-----------+--------------------------------------+
    | ``7``     | Windows 7,                           |
    |           | Windows Server 2008 R2               |
    +-----------+--------------------------------------+
    | ``8``     | *all of 80 and 81*                   |
    +-----------+--------------------------------------+
    | ``80``    | Windows 8,                           |
    |           | Windows Server 2012,                 |
    |           | Windows RT                           |
    +-----------+--------------------------------------+
    | ``81``    | Windows 8.1,                         |
    |           | Windows 2012 R2,                     |
    |           | Windows RT 8.1                       |
    +-----------+--------------------------------------+
    | ``10``    | Windows 10,                          |
    |           | Windows Server 2016                  |
    +-----------+--------------------------------------+

    |
    .. The above line gives some extra space after the table in the helpfile.
       References:
           https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions
           http://www.gaijin.at/lstwinver.php

    """


that is what the size of it would be. I am using this as an example of something that would have a long docstring. not the actual content of this one specifically
If you like the work I have been doing then feel free to Image
User avatar
kgschlosser
Site Admin
 
Posts: 2702
Joined: Fri Jun 05, 2015 5:43 am
Location: Rocky Mountains, Colorado USA

Re: Media Wiki

Postby jonib » Mon Jun 12, 2017 4:19 pm

Disclaimer: This is just my opinion. I won't be doing anything documentation/help related for EG.
kgschlosser wrote:one of the following should happen either we deep six the offline help and go with an online one.
I don't mind EG using an online help but I REALLY want EG to have an offline version available installed with EG.
and when help is clicked in the program then it would load up an IE window or launch the browser and set the address to the online help. or we bundle that help with EG and do not have the online variant.
As long as the help button (or whatever shows the online help) clearly indicates that it uses an external browser for the help.

Ideally there is bundled offline version of the help installed with EG, and when the user invokes the help it shows the online help and if there is no internet it shows the local help instead.

jonib
XBMC2 plugin to control XBMC. If you want to flatter me Image
jonib
Plugin Developer
 
Posts: 1241
Joined: Thu Mar 26, 2009 9:33 pm
Location: Sweden

Re: Media Wiki

Postby kgschlosser » Mon Jun 12, 2017 4:42 pm

@jonib

Now that I am thinking about it. if we moved things like the code/plugin help to a different place and there is the media wiki for the plugins and things of that nature. there there is really no need to offer an online/offline of the help. we could simply stick with bundling one with EG. the big reason for making it online was because if we keep everything like it is when the documenting of the various EG bits starts the Help file would get really bloated with thing that a normal user would not use. this is why i wanted to do an online version of it. so if we move the coding portion of the help into a wiki then i see no reason why it can't stay like it is.


any thoughts on this?
If you like the work I have been doing then feel free to Image
User avatar
kgschlosser
Site Admin
 
Posts: 2702
Joined: Fri Jun 05, 2015 5:43 am
Location: Rocky Mountains, Colorado USA

Re: Media Wiki

Postby topix » Mon Jun 12, 2017 4:47 pm

The user and developer docs are in reStructuredText which is converted with sphinx to HTML and CHM. (Sphinx also supports theming.) Before github the html files were automatically put on the webserver. That is currently not happening but i think that could be easely brought back. I can split the docs to a user and a developer part (already tested) and only add the user doc to the setup.

Does anyone of you know Read The Docs? We could put the user and developer docs there. The will automatically be updated on new releases and the reader can then select the version to read. It' also possible to add different languages. I like that site because it means we don't need to worry about the server setup (folders, version links , etc.). (Just as a demo, will remove it later: http://eventghost.readthedocs.io)

I like to have both, online and offline versions of the help file. From my POV it's easy to have, because we just need to setup it once in our build tool.
topix
Experienced User
 
Posts: 350
Joined: Sat May 05, 2007 3:43 pm
Location: Germany

Re: Media Wiki

Postby kgschlosser » Tue Jun 13, 2017 12:05 am

well if the mechanism is already in place and it's easy to do then go for it. I would like it if we could keep the online stuff all the same. just use Media Wiki. but i think that this would be difficult to do because of sphinx outputting in html and the media wiki is stored in mysql. I guess we would have to see how media wiki works.
If you like the work I have been doing then feel free to Image
User avatar
kgschlosser
Site Admin
 
Posts: 2702
Joined: Fri Jun 05, 2015 5:43 am
Location: Rocky Mountains, Colorado USA

Re: Media Wiki

Postby topix » Tue Jun 13, 2017 5:12 pm

not completly sure but it might be possible to use git to get the contents of mediawiki, change files and commit the changes.
topix
Experienced User
 
Posts: 350
Joined: Sat May 05, 2007 3:43 pm
Location: Germany

Re: Media Wiki

Postby pearbear » Tue Jun 27, 2017 5:44 am

kgschlosser wrote:if for some crazy reason github goes belly up tomorrow and they shutdown all of the servers that information is lost.


I just wanted to check in on the idea we discussed about automatic backups of the Git repository and GitHub data for the EventGhost/EventGhost GitHub repository. Has that been implemented yet? If not I will open an issue on GitHub so the idea doesn't get lost in the noise of the forum.
pearbear
Experienced User
 
Posts: 150
Joined: Mon Apr 02, 2012 10:28 pm

Re: Media Wiki

Postby kgschlosser » Tue Jun 27, 2017 6:06 am

@ pearbear
I am thinking what I am going to do with that is create a cron job on the new server so collect the data off of gitgub. set it up so it does this daily.

if you want pearbear since you have a much better working knowledge of github then I do. if you know of a method to backup everything from github. or if things like getting the commit history. and the issues, PR's all of the comments. have to be individual commands a list of the commands so I can set this up when the time comes that would be of help to me.. But also yes an issue on github would be most helpful for us to remember to do. I really do want to start using the projects portion of github. I think it would really help us organize better.
If you like the work I have been doing then feel free to Image
User avatar
kgschlosser
Site Admin
 
Posts: 2702
Joined: Fri Jun 05, 2015 5:43 am
Location: Rocky Mountains, Colorado USA

Re: Media Wiki

Postby pearbear » Tue Jun 27, 2017 7:12 am

OK, the issue is here:
https://github.com/EventGhost/EventGhost/issues/251
let's continue any discussion there as it will be at least partially off-topic for this thread.
pearbear
Experienced User
 
Posts: 150
Joined: Mon Apr 02, 2012 10:28 pm

Re: Media Wiki

Postby kgschlosser » Wed Jun 28, 2017 8:58 am

ok update...


I have gotten the media wiki updated and operational on the new site.what a pain. there were alot of changes. and one of the things i had to change out what the skin (page layout) to a different one.. I also had to modify a whole mess of stuff to get the authentication against phpbb to function properly. I do not know if this works I have not tested it as of yet. I haven't tested it and I still have to update phpbb tho the database end of things are in place.

so if you want to have a look see.

http://eventghost.rocks
If you like the work I have been doing then feel free to Image
User avatar
kgschlosser
Site Admin
 
Posts: 2702
Joined: Fri Jun 05, 2015 5:43 am
Location: Rocky Mountains, Colorado USA

Previous

Return to EventGhost News

Who is online

Users browsing this forum: Bing [Bot] and 3 guests