[buddypress-trac] [BuddyPress Trac] #6642: BP Template Versioning

[buddypress-trac]

#6642: BP Template Versioning
-----------------------------------------+------------------
 Reporter:  hnla                         |       Owner:
     Type:  enhancement                  |      Status:  new
 Priority:  normal                       |   Milestone:  2.4
Component:  Appearance - Template Parts  |     Version:
 Severity:  minor                        |  Resolution:
 Keywords:  dev-feedback                 |
-----------------------------------------+------------------

Comment (by imath):

 Thanks a lot for your feedbacks and for your reply hnla :)

 This is my contribution to the debate:

 > Is there a way we can update/add template file @internal headers
 automatically?
 That would be great, i agree.

 GlobalIy i'd agree about the translation concern, it's so hard when you're
 not english to understand this kind of link
 http://www.phpdoc.org/docs/latest/references/phpdoc/tags/internal.html  :)
 But as a non english, i'm very happy to have at least some information
 even if it's not in my language, i mean all english is always better than
 0 :)

 About the keyword, honestly i have no preferences, because i don't know
 enough this part. i just think it might be more difficult to parse:
 {{{
 @since 2.3.0 added something
 @since 2.4.0 added another thing
 ...
 @since 4.9.4 ...
 }}}

 The advantage of
 {{{
 @internal {
 Edited: 2.4.0
 Created: 1.7.0
 }}
 }}}
 is it's easy to update the Edited part for the people overridding the
 templates.

 If we can use a custom keyword i'd vote for
 {{{
 @template {
 Edited: 2.4.0
 Created: 1.7.0
 }}
 }}}

 :)

 > I'm not convinced by all the arguments in the "the benefits" section
 (showing it to end users, for example, or how it will help "us" core
 developers in future).

 I may be naive! I thought: if we provide this kind of information, theme
 authors/"template overridders" will play the game (knowing end users could
 see it) and update their templates (Premium themes could even use it as a
 selling argument: my templates are up to date!), allowing end users to
 fully enjoy BuddyPress, letting us be confident in developing new great
 features, because theme authors/"template overridders" would update
 regularly their templates... :)

 This is a first step that can evolved in the future. I think we can wait
 to have something perfect and never have it launched or we can make small
 steps and improve it at each version.

 The most important is to have the templates 'stamped' with at least the
 information of when the template was last edited. If we could have this in
 2.4 using the keyword of your choice (as soon as unique), that would be
 awesome.

 @tw2113 (many thanks to him) did a great work adding doc blocks to each
 template last week-end, it would really be too bad to not fully enjoy his
 work in 2.4.0 because of a keyword :)

--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/6642#comment:9>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac