Content referencing

Mon Jan 18 09:00:37 UTC 2016

It could be a very interesting feature!
Like Davide said, I would use a label instead of id or the simple fact
that if someone write a page and after some time modify that page
deleting or adding new formulas, consistency will be kept only if
using unique label.

About the hovering feature, it is also awesome. The only thing is to
be able to use a tooltip. Try to give a look at this
https://www.mediawiki.org/wiki/Extension:Tooltip

Integrating the content-ref tag in a template should not be a problem,
because it does not style the element (if it does, the fix is simple).
We may need to test it both on css adn ocg sides, so we can work
better together.

Regarding the feature of recerencing with latex, if you could just
catch and parse the content id and put a "\label{}" and also catch a
content-ref and put "\ref{}" maybe the link to db table is not
necessary. However, this method could lead to problems when the
referencing pages aren't in the same book, so for now I don't know, it
was just a thought.

Well done Russell!

Gianluca

2016-01-18 1:46 GMT+01:00 Davide Valsecchi <valsecchi.davide94 at gmail.com>:
> I have an idea that could make this feature really interesting for users.
>
> We should reproduce a sort of label/ref latex mechanism along all wiki
> pages.
> When a label it's create with our tag, the section of the page to which it
> refers is saved in a table in db and made unique.
> When another page use <content-ref label=> a link to the right content is
> created, without the need of knowing the right page.
>
> To make things neat we should use a sort of "scope" for labels. When writing
> ref for a specific course the user should use a label like
> "/coursename/label". Doing so, similar labels won't conflict and they will
> be easier to use and categorize.
>
> Then we can go further. Imagine a tool that read all the labels and made
> them searchable. We could also add metadata to label tag and made this
> information avaiable for queries. When someone wants to refer a theorem or a
> specific part, he has only to query to check if an existing content exists.
>
> Alessandro, that could really interest you for semantics features.
>
>
>
>
>
>
> 2016-01-18 0:56 GMT+01:00 Russell Greene <russellgreene8 at gmail.com>:
>>
>>
>>
>> On Sun, Jan 17, 2016 at 4:48 PM Davide Valsecchi
>> <valsecchi.davide94 at gmail.com> wrote:
>>>
>>> Really good ideas! I have some comments to do
>>>
>>> 2016-01-18 0:19 GMT+01:00 Russell Greene <russellgreene8 at gmail.com>:
>>>>
>>>> Hey all, last night I made an MediaWiki extension for doing content
>>>> referencing. The idea is for this to be applied to figures, equations,
>>>> anything that would want to be referenced back to later.
>>>>
>>>> Everything here is on the GitHub repo, under the branch
>>>> ContentRefrencer, give it a try!
>>>>
>>>> Anything here is up for debate/change.
>>>>
>>>> Motivation:
>>>>
>>>> Reuse of content. This way one chapter that requires a certain proof or
>>>> math equation, they can reference to there, where it is explained in more
>>>> depth instead of explaining it again.
>>>>
>>>> Syntax:
>>>>
>>>> Currently there are two new tags, content and content-ref.
>>>>
>>>> Example:
>>>>
>>>> <content name="Quadratic Formula" id=1.0>
>>>> <math> ... </math>
>>>> </content>
>>>>
>>>
>>> I think that it would be better to use a label instead of a numerical id.
>>> It would be remembered and referred easier.
>>> Look at Latex ref/label, you are trying to recreate the same behavior.
>>
>> Okay! That should be really easy. I'll push that in a minute.
>>
>>>
>>>
>>>>
>>>> and then later
>>>> <content-ref id=1.0>See Quadratic formula</content-ref>
>>>>
>>>> This will work for any <content> elements in that page. In order to
>>>> reference to a different page, just add the page attribute to the
>>>> <content-ref> element:
>>>>
>>>> <content-ref page="Physics/Quantum Mechanics" id=3>...</content-ref>
>>>>
>>>
>>> It works impressively! I see that for now it displays: "Figure: $name".
>>> Why don't create a parameter for the type of reference? Like type=Figure or
>>> type=math.
>>
>>
>> I totally agree. The "Figure: " was just for demonstration purposes.
>>
>>>
>>>>
>>>> Features:
>>>>
>>>> So as of right now, this is very simple, and could live in a template,
>>>> but there are more options with an extension.
>>>>
>>>
>>> You know that we are using templates for theorems and definitions and so
>>> on. Do you think that we could use your ref tag to create a link to them? We
>>> can insert a label/id in the template, or maybe include automatically al the
>>> content inside a <content> tag, but without your extension box. Maybe the
>>> box could be optional?
>>
>> One idea would be to include a <content> tag in the templates, so they can
>> be referenced by a <content-ref>. This would keep the consistency that
>> templates give, while also being referable.
>>>
>>>
>>>
>>>
>>>>
>>>> Hover
>>>> One feature I really want to figure out is showing the contents of the
>>>> <content> tag when hovering over the corresponding <content-ref> tag. This
>>>> would allow anyone to be able to see the content without even navigation
>>>> outside the page.
>>>>
>>>> dmath
>>>> One cool feature would to have support similar to this in the dmath tag,
>>>> to make it easier to pass on to OCG.
>>>
>>>
>>> I think that for math we should pay a lot of attention. Maybe it would be
>>> possible to insert a label inside dmath tag and then make reference to it
>>> with your <content-ref> tag. Including math inside a <content> tag it's not
>>> optimal because I don't know how we could make OCG recognize the link.
>>>
>> We have full control over what the <dmath> tag does, so anything is
>> possible. I am not familiar with how OCG works, so I would need someone to
>> hold my hand through that.
>>
>>>
>>> I hope my suggestions could give you hints. I think that a general way to
>>> ref things is excellent, but we have to integrate it also in templates and
>>> math.
>>>
>>> What do you think?
>>>
>>>
>>> Davide
>>>
>>>>
>>>>
>>>> So what do you think? Is this something we need? Additional thoughts?
>>>>
>>>> -Russell
>>>>
>>>> _______________________________________________
>>>> WikiToLearn-Tech mailing list
>>>> WikiToLearn-Tech at kde.org
>>>> https://mail.kde.org/mailman/listinfo/wikitolearn-tech
>>>>
>>>
>
>
> _______________________________________________
> WikiToLearn-Tech mailing list
> WikiToLearn-Tech at kde.org
> https://mail.kde.org/mailman/listinfo/wikitolearn-tech
>

-- 
Gianluca