[theme-reviewers] Plugin-Like Readme.txt for Themes

[Edward Caissie]

I've been playing around with varying formats but mostly via my
changelog.txt file which I have been more or less modeling after the plugin
readme structure.

I've just started adding readme files to my themes so I've been on a more
loose structure so far.


On Sat, Sep 25, 2010 at 10:43 PM, Chip Bennett <chip at chipbennett.net> wrote:

> I've taken a stab at making use of the Plugin-standard readme for a Theme.
> See my example here: <http://themes.trac.wordpress.org/ticket/1273>
>
> Chip
>
>
> On Sat, Sep 25, 2010 at 9:37 PM, Edward Caissie <edward.caissie at gmail.com>wrote:
>
>> I think the file itself should be required ...
>>
>> ... as to formatting and other related criteria, I think using the Plugin
>> repository version as a template would work well as a starting point.
>>
>> If we can get some idea if this is possible, and a reasonable(?)
>> time-line, we can start working on what could be expected to be included in
>> the file, too.
>>
>>
>> Cais.
>>
>>
>> On Sat, Sep 25, 2010 at 10:32 PM, Chip Bennett <chip at chipbennett.net>wrote:
>>
>>> That is exactly my reasoning for bringing it up.
>>>
>>> Being able to have repository listing-page sections for FAQs, Use
>>> Instructions, etc. would be an incredible boon. And getting Theme developers
>>> in the habit of adding readme documentation similar to what Plugin
>>> developers provide can only help end-users.
>>>
>>> Also, as the Review Team more and more require certain Theme
>>> customizations and intended uses (e.g. for "specialized-use" Themes) to be
>>> documented, having a standard readme format will help Theme developers
>>> comply with such requirements.
>>>
>>> Chip
>>>
>>>
>>> On Sat, Sep 25, 2010 at 9:13 PM, Edward Caissie <
>>> edward.caissie at gmail.com> wrote:
>>>
>>>> +1 to this idea.
>>>>
>>>> It would go a long way to adding, in some cases, much needed theme
>>>> documentation.
>>>>
>>>>
>>>> Cais.
>>>>
>>>> On Sat, Sep 25, 2010 at 10:09 PM, Chip Bennett <chip at chipbennett.net>wrote:
>>>>
>>>>> Mostly a question for Joseph and Otto:
>>>>>
>>>>> What would it take to implement the ability for Themes to provide a
>>>>> Plugin-like Readme.txt (using the same markdown, and generating the same
>>>>> sections on the Theme's repository listing page)?
>>>>>
>>>>> I know this suggestion has been kicking around for a LONG time... what
>>>>> can we do to make it happen?
>>>>>
>>>>> Chip
>>>>>
>>>>> _______________________________________________
>>>>> theme-reviewers mailing list
>>>>> theme-reviewers at lists.wordpress.org
>>>>> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>>>>>
>>>>>
>>>>
>>>> _______________________________________________
>>>> theme-reviewers mailing list
>>>> theme-reviewers at lists.wordpress.org
>>>> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>>>>
>>>>
>>>
>>> _______________________________________________
>>> theme-reviewers mailing list
>>> theme-reviewers at lists.wordpress.org
>>> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>>>
>>>
>>
>> _______________________________________________
>> theme-reviewers mailing list
>> theme-reviewers at lists.wordpress.org
>> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>>
>>
>
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wordpress.org/pipermail/theme-reviewers/attachments/20100925/1bf3e6c8/attachment.htm>