You are here: Foswiki>Development Web>FeatureItem>ActionItem1359 (25 Feb 2010, JoenioCosta)EditAttach

#1359: Infrastructure for documentation

Type: FeatureItem Feature: Documentation Tags: safernet
ScheduledFor: 0.22.0? Assigned to: AntonioTerceiro Task Points: 4
Priority: 0 Status: Done  
These are the requirements identified so far

Status requirement obs.
OK the documentation must be written in a convenient format for documentation writers Textile chosen
OK the translation must be done via .po files  
OK the documentation is part of Noosfero's source code  
OK the documentation must be made available in all Noosfero instances at /doc  
OK using the same layout as the current noosfero environment  
OK it must be possible to translate images (i.e. provide a translated version of the image which noosfero will prefer when display the doc)  
OK it must be possible for themes to provide their own versions of the images used in the documentation  
OK There must be a convenient way to navigate through the different sections of the documentation  
OK There must be a "breadcumbs" navigation above the title of each topic (e.g. "Documentation » Section » Specific Topic"  
OK At every release the translated documentation must be regenerated.  
rejected Write documentation on how to translate the documentation  
OK the local admin must be able to add arbitrary links to the left menu (?)  
OK the default theme must have a very visible link to the documentation browser  

-- JoenioCosta - 21 Dec 2009

  • Captura_da_tela.png:
    Captura_da_tela.png

documentation files storage:

What source tree URL
Documents doc/noosfero/$section/$topic-name-with-dashes.textile /doc/$section/$topic-name-with-dashes
Images public/images/doc/$image-name-with-dashes.en.png /images/doc/$image-name-with-dashes.en.png
Translated images public/images/doc/$image-name-with-dashes.$lang.png /images/doc/$image-name-with-dashes.$lang.png

-- AntonioTerceiro - 29 Jan 2010

Add comment
You need to login to be able to comment.
 

Commits

Display the commits related to this action item!

ActionItemForm edit

Title Infrastructure for documentation
ActionItemType? FeatureItem
Priority 0
Tags safernet
Feature Documentation
TaskPoints? 4
ResponsibleDevelopers AntonioTerceiro
ScheduledFor? 0.22.0?
AffectsVersion?
Status Done
Ticket SAC:

► Attachments

▼ Attachments

Topic attachments
I Attachment Action Size Date Who Comment
pngpng Captura_da_tela.png manage 68.9 K 08 Jan 2010 - 20:34 AntonioTerceiro  
Edit | Attach | Print version | History: r11 < r10 < r9 < r8 < r7 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r11 - 25 Feb 2010 - 12:54:11 - JoenioCosta
 
Copyright © 2007-2010 Noosfero
Colivre - Cooperativa de Tecnologias Livres