4 # Writing documentation for the DALi programing guide {#documentationguide}
6 To allow documentation to be shared between C++ and JavaScript, please follow these guidelines:
8 - Create a mark down file (.md) using GitHub Flavoured Markdown https://help.github.com/articles/github-flavored-markdown/
9 - Put it into the shared C++ / JavaScript documentation: dali-toolkit/docs/content/shared-javascript-and-cpp-documentation/~
10 - Include code samples for both C++ and JavaScript in the mark down.
11 - See script-overview.md overview in dali-toolkit/docs/content/shared-javascript-and-cpp-documentation for an example
12 - For YUIDOC to parse the file it needs:
13 - Enclosed in code comment block
14 - Have a class tag with a description of the file
15 - For DOXYGEN to link to the mark down it currently needs a reference {hash myfile}
19 Images are shared between both Doxygen and YUIDOC tools using a symbolic link.
20 You need to link to the image twice in shared documentation.
21 This is because YUIDOC stores images in a folder called assets/img/ which is relative to the HTML pages.
22 Where as Doxygen copies all images in to the same folder as the HTML generated pages.
25 ![ ](../assets/img/screen-shot.png) // required for YUIDOC
26 ![ ](screen-shot.png) // required for Doxygen
28 The space between the brackets is the alternative text. This means you will never see a broken image symbol.
33 Please have a look at the numerous markdown files to see the header and footer requirements.
35 You can add tags to your headings as follows:
37 # MyChapter {#my-chapter}
39 Which will allow you to link to this section as follows:
41 [Go To MyChapter](@ref my-chapter)
44 Code blocks can be enclosed within 2 blocks of 3 tildas(~).
46 You can even specify your language type, for example:
53 #### Why use GitHub flavoured markdown?
54 - Table support is good and language specific code blocks are easier to define ( javascript/C++).
55 - Doxygen and YUIDOC both support it.
58 @class _Guide_Writing_DALi_Programming_Guide_Documentation