Moodle Community Sites

Helen, please expand the spec if you think of anything. I was considering using the current language to link to the appropriate page in Moodle Docs but that might not be a good idea (different people going to different pages).

As Severin point out, we can do direct language links like this:

[[fr:Installation de Moodle]] --> <a href="http://docs.moodle.org/fr/Installation_de_Moodle" title="Moodle Docs">Installation de Moodle</a>

I think a filter for linking to documentation pages is a great idea!

My only suggestion for improvement is to consider making the link text clearer. There are so many filters used on moodle.org (see http://docs.moodle.org/en/Filters_used_on_the_Moodle.org_forums) that it can be confusing not knowing whether a highlighted link will take you to a glossary entry, a database entry, another activity etc. Having title text is a help, of course, but I'm wondering about including the word "documentation" in the link text, for example

[[Installing Moodle]] ---> <a href="http://docs.moodle.org/en/Installing Moodle" title="Moodle Docs">Installing Moodle documentation</a>

I'm not sure how this would work in other languages, or indeed whether it makes sense to always append the word "documentation", so comments on my suggestion would be appreciated.

That probably wouldn't work for all languages, but how about a little icon: Installing Moodle [D] (Where [D] is a little Docs icon)

Well, I'll be ....

Valery pointed out this exists already. Why didn't I check the modules database? :-P

http://moodle.org/mod/data/view.php?d=13&rid=602

Yes, a little Docs icon could be used. Alternatively, we could prefix the page title with "Moodle Docs - ", for example

[[Installing Moodle]] ---> <a href="http://docs.moodle.org/en/Installing Moodle" title="Moodle Docs">Moodle Docs - Installing Moodle</a>

It's great that Valery has created a Wikipedia filter already

Can this be considered resolved, then? What's the final syntax for filtering? Is it installed in moodle.org?

Eloy, no, it's not yet installed on moodle.org.

Uhm...following the work done by the multimovie filter (http://moodle.org/mod/data/view.php?d=13&rid=624)... what about to create one filter using this syntax (to have it more or less uniform):

[[docs:pagename|title]]

I think I can do it in 1 hour or so. FYC.

Done. You can see it here:

http://cvs.moodle.org/contrib/plugins/filter/moodledocs/

syntax: http://cvs.moodle.org/contrib/plugins/filter/moodledocs/README.txt?view=markup

it also respects $CFG->docroot and $CFG->doctonewwindow

FYC, ciao

I was really hoping to use the same syntax on moodle.org as we use on docs.moodle.org ... can we just make it so that both work? ie if the prefix is missing then it defaults to making a docs link?

Main problem leaving the prefix out is that it can cause conflict with other filters, more where colons (the prefix separator) are often used in page names (all the "Development:xxxxx" for example). There is no way to differentiate that colon from a prefix one.

That's the cause I added the prefix to the first multimovie filter and now to the moodledocs filter. To avoid conflicts between filters sharing that wediawiki-like syntax. Imagine they are the prefixes used by interwiki links.

Anyway, I can make a stripped version of the filter, ignoring prefixes completely. Just be 100% sure it will be "incompatible" with other filters using that sort of syntax (plus leading people to confusion if the syntax in moodle.org is different from the syntax in their own sites).

Your decision,

Ciao

I know having a docs prefix is a technically perfect solution but I think it's not as usable as it could be in this case.

I think it'll be a good compromise if you make it detect prefixes like this:

if "mm:" then exit now
if "xxx:" where xxx is any other filter prefix we know about about then exit now
if "docs:" then strip "docs:" and continue
make it into a link as above

Could you do that please?

Done.

Now prefix is optional in the syntax.

If nothing or "docs" is found, the filter will process the link.

If anything else, being 2-4cc lowercase, is found (like "mm"), assume it's another link and skip it to be processed by another filter (like multimovie).

I think this is ok with your plan above and save us to hardcode the list ok known prefixes. Anything 2-4cc lowercase will be considered prefix.

http://cvs.moodle.org/contrib/plugins/filter/moodledocs/README.txt?view=markup

Ciao

THANKS, great!

I've got it on moodle.org - works great!

Yes, thanks a lot, Eloy

I've just tested it and found all your README examples working fine, apart from [[Manual de Estilo de Código||es]], which was displayed as

Manual de Estilo de Código">Manual de Estilo de Código

where the word "Manual" linked to the Manual module in the modules and plugins database.

Ah, I guess we need to put the "moodledocs" filter BEFORE the "database", "glossary" and so on... doing that now in moodle.org...

Duh! Thanks Eloy

Just writing some documentation on the new filter before posting in the documentation forum.

Done. Now moodledocs filter has precedence over glossary, database and activity names. Resolving as fixed.

Ciao

Moodle Docs auto-linking filter documentation added:

http://docs.moodle.org/en/Filters_used_on_the_Moodle.org_forums
http://docs.moodle.org/en/Moodle.org_FAQ

Forum post: http://moodle.org/mod/forum/discuss.php?d=104437

Thanks again guys

Awesome and definitely a wowie zowie for me. Side benefit: Hope it encourages others to link to MoodleDocs.

Double brackets on each end, will take a copy and paste of the page name, use the "|" function for alternative displayed text, recognizes the # section heading and treats the underscore just like a space.

Looks like I will have a Foster's Bitter on your behalf tonight !

Best Chris

I've improved a bit the handling of colons, slashes and hashes. Filter updated in moodle.org too.

Ciao

Reopening this issue following a problem reported by Robert B:

Some time this year, I think in August, the links to Moodle docs stopped coming through as links in forum posts. That is instead of

http://docs.moodle.org/en/Developer_meeting_November_2008

I am getting

[ [ Developer meeting November 2008 ] ]

which is not as handy as the link if I want to see it (I added extra spaces so the filter does not convert this to link). My settings make Moodle send mail as plain text, so may be this works fine in HTML mode.

Is this a correctable issue? I suspect that the filter does not process the text mail.

http://moodle.org/mod/forum/discuss.php?d=109935&parent=488826#p488854

uhm... is this really a bug? Or... perhaps... text mails never have been processed by filters? I cannot imagine anything in that filter making it special at all.

Hi Helen,

just reclosing this because of dupe of MDLSITE-578 (that I've discovered some secs ago). I'll add you there. Ciao