[Build-common-hackers] Documenting CDBS

Jonas Smedegaard dr at jones.dk
Wed Dec 22 12:29:20 UTC 2010


On Wed, Dec 22, 2010 at 08:34:19AM -0300, Felipe Sateler wrote:
>On Wed, Dec 22, 2010 at 07:17, Jonas Smedegaard <dr at jones.dk> wrote:
>> On Tue, Dec 21, 2010 at 08:51:29PM -0300, Felipe Sateler wrote:
>>> I have no particular love for XML, but docbook does have the 
>>> advantage (that the current documentation is not taking) of 
>>> splitting stuff into smaller files and then do cross-references 
>>> among them (or even subsections of files). Can Markdown do that?
>>
>> Sure Docbook can do a lot that simpler formats cannot.  But please 
>> let os only emphasize issues relevant to ourselves for this project.
>>
>> Do you find that cross-referencing feature important here?  If so, 
>> please elaborate, as I am not quite sure what it is (guessing it is 
>> more than generating a table of contents).

>The most obvious cross-referencing applications is for variables and 
>targets tables/lists. They can be used in the more tutorial-like part 
>of the documentation and then put as reference in an appendix for 
>already users of CDBS. Can Markdown do this, without involving 
>copy/paste or links to other pages?

Sorry, I still don't get it.  Could you perhaps point to an example of 
that use?


  - Jonas

-- 
  * Jonas Smedegaard - idealist & Internet-arkitekt
  * Tlf.: +45 40843136  Website: http://dr.jones.dk/

  [x] quote me freely  [ ] ask before reusing  [ ] keep private
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/build-common-hackers/attachments/20101222/2fcc94c3/attachment.pgp>


More information about the Build-common-hackers mailing list