<![CDATA[ MODX Documentation Improvements and Expansion - MODX Community Forums]]> https://forums.modx.com/thread/?thread=3998 <![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=7#dis-post-485419 http://aditya.bhatts.org/2013/12/16/bringing-opendocument-to-the-web/]]> sottwell Dec 17, 2013, 07:51 AM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=7#dis-post-485419 <![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=7#dis-post-483453
How easy would it be to get the topic menu on the left to stay positioned so the page you are in is visible?

For example, if I scroll down and select Formit, the whole menu skitters back down and I am suddenly with no reference as to the other pages in the FormIt section unless I scroll right to the bottom of the page or scan back down the menu. There are 17 pages in this section and it would be great to have the top level page in the current section automatically position at or near the top so that you could browse the section with ease smiley

Looking the the menu code, I see the current top-level item is
class="current open"
Could js be used to slide that item up to, say, 100px from the top?]]>
Gav Nov 19, 2013, 02:19 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=7#dis-post-483453
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475033
For example: http://rtfm.modx.com/revolution/2.x/developing-in-modx/other-development-resources/class-reference/modx/modx.makeurl

The info is pulled from the PhpDoc comments, but for makeUrl() they look like this:

    /* @access public
     * @param integer $id The id of a resource.
     * @param string $args A query string to append to the generated URL.
     * @param mixed $scheme The scheme indicates in what format the URL is generated.<br>
     * <pre>
     *      -1 : (default value) URL is relative to site_url
     *       0 : see http
     *       1 : see https
     *    full : URL is absolute, prepended with site_url from config
     *     abs : URL is absolute, prepended with base_url from config
     *    http : URL is absolute, forced to http scheme
     *   https : URL is absolute, forced to https scheme
     * </pre>
     * @param array $options An array of options for generating the Resource URL.
     * @return string The URL for the resource.

Only the part between the pre tags is making it into the docs.]]>
BobRay Aug 14, 2013, 11:23 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475033
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475031 sottwell Aug 14, 2013, 11:11 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475031 <![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475009
Currently your old RTFM login will not work (your modx.com login should work in the next couple of weeks). We would be happy to have anyone who was an editor/contributor with access to rtfm.modx.com previously to help us in this effort. Top priority is to get the first 50 most visited pages back into shape. There are quite a number of pages that are missing or have malformed content. Volunteers would review the pages on both the new docs and the old docs and migrate content over manually to the new docs. Ideally, the process of migration would also include cleaning the markup and stripping any of the Confluence classes and such. The new docs only have a few styles and are mostly based around standard HTML Markup. There is a WYSIWYG editor on the documentation, however, the process will still require people to work with HTML. If this doesn't appeal, don't worry, we'll certainly look for you to help in editing and making content better when we reach that phase.

If you wish to participate in helping clean up the docs, please send me an email to help@modx.com.]]>
smashingred Aug 14, 2013, 08:15 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-475009
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461629 Quote from: exside at Apr 03, 2013, 05:50 PM
solution is to shoot a email at kevin@modx.com and ask for a RTFM login
Thanks a lot for solution.

But you are right about a necessity of simplifications of this kind.
I think that it should be great if the login to RTFM will be identical with any other *.MODX.com login. And if it will have the same procedure to register.]]>
trianman Apr 04, 2013, 06:23 AM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461629
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461489 exside Apr 03, 2013, 12:50 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461489 <![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461475 Nothing to add.
I often want to add precisions/corrections inside the doc, but I can't...
Too bad... sad]]>
Spheerys Apr 03, 2013, 11:29 AM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-461475
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-457384 http://rtfm.modx.com

I think that all articles on rtfm.modx.com should be available for user commenting. Such as documentation on MySQL or PHP ( http://dev.mysql.com/doc/refman/5.6/en/expressions.html or http://www.php.net/manual/en/language.types.type-juggling.php )

So users can help authors of documentation to improve their articles.

Or may be all documentation should be wikified to gain achievements of this kind. So anybody could improve it.

UPD: I've found the ticket about same problem http://tracker.modx.com/issues/7374 but I have another point of view rather than amdbuilder's: through development process I find a lot of improvements into documentation I can make. But I haven't any tools to publish such kind of improvements to be instantly available to other MODXers.

I have no questions, I have the answers, but there isn't any adequate place to publish them.
"That makes me a sad panda."]]>
trianman Mar 04, 2013, 05:23 AM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-457384
<![CDATA[Re: MODX Documentation Improvements and Expansion]]> https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-449695
I see gaps in information often and would love to help make the documentation as clear and concise as possible for current and future MODXers.

PM me or hit me up on Twitter if I can help!]]>
eric.swd Jan 07, 2013, 09:22 PM https://forums.modx.com/thread/3998/modx-documentation-improvements-and-expansion?page=6#dis-post-449695