Editing Google Season of Docs/Project Ideas

From BRL-CAD

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 45: Line 45:
 
* https://docbook.org
 
* https://docbook.org
 
* https://antora.org
 
* https://antora.org
|width=18% align=center bgcolor=#eee|Docbook XML, AsciiDoc, Markdown, Antora
+
|width=18% align=center bgcolor=#eee|Docbook XML, Markdown, Subversion, Antora
 
|width=10% align=center|Medium
 
|width=10% align=center|Medium
 
|width=10% align=center bgcolor=#eee|morrison, rossberg, yapp
 
|width=10% align=center bgcolor=#eee|morrison, rossberg, yapp
 
|}
 
|}
 +
  
 
= Organize all existing user docs =
 
= Organize all existing user docs =
Line 104: Line 105:
 
|width=18% align=center bgcolor=#eee|Doxygen, Subversion, C/C++ code comments
 
|width=18% align=center bgcolor=#eee|Doxygen, Subversion, C/C++ code comments
 
|width=10% align=center|Medium
 
|width=10% align=center|Medium
|width=10% align=center bgcolor=#eee|yapp, morrison, rossberg
 
|}
 
 
 
= Convert unmanaged to managed =
 
 
{| bgcolor=#fff
 
!
 
!align=center|Technologies
 
!align=center|Difficulty
 
!align=center|Contacts
 
|-
 
|width=62%|BRL-CAD has several books, presentations, and other documentation written in familiar publishing tools like Microsoft Word, Microsoft Powerpoint, Adobe InDesign, LaTeX, Apple Pages, and more.  They are "unmanaged" in the sense that they are not easily kept in sync, unlike the majority of BRL-CAD's docs that are compiled alongside code and easily updated with a text editor (i.e., "managed").  The main reason they are unmanaged is because they have specific layout and formatting.  For this project, the goal is to figure out how to manage them so that they're in an editable markup format like AsciiDoc **and** any custom formatting is preserved (e.g., through the use of stylesheets).
 
References:
 
* https://github.com/Ardemius/asciidoctor-presentation
 
* https://asciidoctor.org/docs/asciidoctor-revealjs/#convert-asciidoc-into-slides
 
* http://rhythmus.be/md2indd/
 
* https://pandoc.org
 
|width=18% align=center bgcolor=#eee|AsciiDoc, Pandoc, Markdown, Docbook XML
 
|width=10% align=center|Hard
 
 
|width=10% align=center bgcolor=#eee|yapp, morrison, rossberg
 
|width=10% align=center bgcolor=#eee|yapp, morrison, rossberg
 
|}
 
|}

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)