unique observer-identifier for bbcode and for Comanche Page Description Language

Tue, 16 May 2017 11:07:52 +0200

I suggest unique identifier for variables [observer] in the Hubzilla specific codes for bbcode and $observer in the Comanche Page Description Language (CPDL) to use. The same identifier observer(bbcode) and observer(CPDL) confuse the Hubzilla-user, specially Hubzilla-Beginners and caused enquiries. I mean for example those unique identifier (proposal):

bbcode: observerBbc
CPDL: observerCpdl

German Version:
Ich nehme an, dass nicht nur für mich es ziemlich irritierend ist, dass die Bezeichner (Identifikatoren) für die o.g. Variablen [observer] und $observer identisch sind. Hinzu kommt, dass beide völlig unterschiedliche Variablen, die - nehme ich an - in Hubzilla in unterschiedlichen voneinander unabhängigen Modulen bearbeitet werden, für die Lösung von gleichen Aufgaben einsetzbar sind. Bin der Meinung, dass mit der Einführung von eindeutigen Identifikatoren für [observer] und $observer einer Vielzahl von Mißverständnissen und auch Anfragen an den @Hubzilla Support Forum+ bzw. an @Hubzilla Development+ vorbeugen kann und bitte hier für meinen Vorschlag abzustimmen.

show all 8 comments

Mike Macgirvin

Tue, 16 May 2017 22:53:29 +0200

We already have a unique identifier. In bbcode it is observer. In PDL it is $observer.

neue medienordnung plus

Wed, 17 May 2017 04:00:42 +0200

@Mike Macgirvin Contains the Hubzilla Help anywhere definitions for observer and $observer? I mean, that observer und $observer two important things are, these in Hubzilla-Help need to declare.

hEARt PhoniX

Wed, 17 May 2017 04:26:39 +0200

Hm. This has never really been confusing to.me as I saw both as completely different things. $observer connects to the php context of pdl. But your concern is valid and I will take it on. Good catch, good to point out in the doco.

Mike Macgirvin

Wed, 17 May 2017 04:37:40 +0200

Contains the Hubzilla Help anywhere definitions for observer and $observer?

I don't really know. Why don't you find out?

neue medienordnung plus

Wed, 17 May 2017 05:05:57 +0200

Why don't you find out?

I mean, that a benfit is, when Hubzilla-docu contains definitions and explanations for observer and $observer concepts for normal user, not-programmer. Because bbcode is an thing, wich well be to apply from normal user, not only from programmer and Hubzilla-Admins.

Mike Macgirvin

Wed, 17 May 2017 05:30:29 +0200

What I was basically trying to say was, "This is open source, mate. If something needs fixing - fix it."

neue medienordnung plus

Wed, 17 May 2017 05:59:15 +0200

@Mike Macgirvin Can you may be summarise the definitions, idea for observer and $observer in a couple of sentences? The definitions, these up to now was used in the Hubzilla programming.

Mike Macgirvin

Wed, 17 May 2017 06:54:20 +0200

Hubzilla is a decentralised identity platform and the 'observer' mechanism provides access to some of these identity features in a way that is accessible for normal members. This may be used to alter the content or text of a published article (in the case of bbcode), or page layout (in the case of Comanche) based on unique characteristics of the person viewing the page. In each case the exact syntax depends on which facility (content or layout) you are using and the results you are trying to achieve.

https://hub.freecommunication.org/help/member/bbcode#Hubzilla_specific_codes

https://hub.freecommunication.org/help/member/member_guide#Comanche_Page_Description_Language

The Comanche guide probably needs updating as there have been a lot of changes in conditional variable handling in the last few months. A lot of this can be copied directly from the code comments in Zotlabs/Render/Comanche.php, which are to my knowledge fairly accurate and detailed.