Changes between Version 158 and Version 159 of ImprovingBoostDocs
- Timestamp:
- Jul 13, 2007, 4:30:20 PM (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ImprovingBoostDocs
v158 v159 4 4 * '''[ImprovingBoostDocs About this project]''' 5 5 * [BoostDocsRepository Boost docs repository] 6 * [UnifiedLookAndFeelProject Unified look &feel project]6 * [UnifiedLookAndFeelProject Unified look-and-feel project] 7 7 * [DocsTranslationsProject Docs translations project] 8 8 * [GlueDocsProject Glue docs project] … … 24 24 [[Image(CommonImages:design.png,nolink)]] 25 25 26 * Build up a long term community of people that cares and constantly improve 27 boost documentation and tools. 26 * Build up a long-term community of people who care and constantly improve Boost documentation and tools. 28 27 29 28 * Achieve an unified look and feel between docs and Boost resources, integrating them as … … 32 31 * Quality documentation 33 32 [[Br]][[Br]] 34 * Provide correct, current and readable documentation for the Boost C++ libraries, 35 tools, environment and organization. 36 [[Br]][[Br]] 37 * Generate Glue docs that sees boost as one tied entity, providing 38 real-world examples, best practices for common tasks and tutorials about how 39 to combine Boost libraries together to build high-quality C++ applications. 40 [[Br]][[Br]] 41 * Provide a publicly available, vendor-neutral reference manual for the Standard C++ 42 library, STL concepts, data types and algorithms as part of the Boost library 43 documentation. 44 [[Br]][[Br]] 45 * Make it easier for users to navigate through the enormous amount of 46 boost documentation. 47 [[Br]][[Br]] 48 * Use latest version of standards and support old browsers. 49 [[Br]][[Br]] 50 * Include nice looking logos and diagrams. Although Boost libraries are so great 51 that they do not need any marketting at all, lets face it: people are attracted 52 like flies to catchy names and fancy pictures. 33 * Provide correct, current and readable documentation for Boost C++ libraries, tools, environment and organization. 34 [[Br]][[Br]] 35 * Generate Glue docs that see Boost as one unified entity, providing real-world examples, best practices for common tasks and tutorials on how to combine Boost libraries in order to build high-quality C++ applications. 36 [[Br]][[Br]] 37 * Provide a publicly available, vendor-neutral reference manual for the standard C++ library, STL concepts, data types and algorithms as part of the Boost library documentation. 38 [[Br]][[Br]] 39 * Make it easier for users to navigate the enormous amount of Boost documentation. 40 [[Br]][[Br]] 41 * Use the latest version of standards and support old browsers. 42 [[Br]][[Br]] 43 * Include attractive logos and diagrams. Although Boost libraries are of such good quality that they do not need any marketing at all, let's face it: people are drawn to fancy names and eye-catching pictures. 53 44 54 45 * Documentation tools and support 55 46 [[Br]][[Br]] 56 * Improve the docs tool chain, simplifying and integrating it lowering the barrier 57 for people willing to help us. 47 * Improve the docs tool chain, simplifying and integrating it, thereby lowering the barrier for people willing to help us. 58 48 [[Br]][[Br]] 59 * Develop tools to automate common task, and to make life easier to boost authors. 60 Docs writers should concentrate on generating content and not on figthing with tools. 61 [[Br]][[Br]] 62 * Work to make doc tools boost-agnostic. We believe that they are useful beyond 63 the boost community, and would welcome anyone who wishes to use, extend or 64 support them. 49 * Develop tools to automate common tasks and to make life easier for Boost authors. Document writers should concentrate on generating content and not on fighting with tools. 50 [[Br]][[Br]] 51 * Work to make doc tools Boost-agnostic. We believe that they are useful beyond the Boost community and would welcome anyone who wishes to use, extend or support them. 65 52 66 53 * Generate formal documents about C++ documentation best practices. 67 54 68 * Offer our help to libraries authors. This include translations, proof-reading, 69 proposing examples and tutorials for their libraries and helping them with the 70 docs tool chain. 71 72 * Offer a place where not C++ experts can help the Boost community. In general the 73 tasks we do here does not involve template metaprogramming or others complex C++ 74 machinery. Dessigners, artists, teachers, web experts, Python programmers and Boost 75 users are very welcome along our lines. 55 * Offer our help to library authors. This includes translations, proof-reading, proposing examples and tutorials for their libraries and helping them with the docs tool chain. 56 57 * Offer a place where those who are not experts in C++ can help the Boost community. In general, the tasks we do here do not involve template metaprogramming or other complex C++ machinery. Dessigners, artists, teachers, web experts, Python programmers and Boost users are very welcome to contribute. 76 58 77 59 * Write docs, include rationales, use our own tools. If we want to improve boost docs, 78 60 we should start by showcasing best practices in this project. 79 61 80 * Enjoy our work. If we are not having fun while improving boost docs something 81 has gone terribly wrong. 62 * Enjoy our work. If we are not having fun while improving Boost docs something has gone terribly wrong. 82 63 83 64 ---- … … 87 68 [[Image(CommonImages:resources.png,nolink)]] 88 69 89 At IBD we use several open source tools to organize our efforts. In this section the purpose 90 of each resource is explained. When possible, IBD resources will be interlinked and share a 91 common look and feel allowing a consistent experience for both users and developers. 92 93 Although the only resources that every IBD developer must use are the boost docs subversion repository, the 94 boost docs list and the project Wiki, we encourage you to read this section and use the rest 95 of the tools; Combined they are a complete community development suite. 70 At IBD, we use several open-source tools to organize our efforts. In this section the purpose of each resource is explained. When possible, IBD resources will be interlinked and have a common look and feel, allowing a consistent experience for both users and developers. 71 72 Although the only resources that every IBD developer must use are the Boost docs subversion repository, the Boost docs list and the project wiki, we encourage you to read this section and use the rest of the tools; combined, they are a complete community development suite. 96 73 97 74 === Project output === … … 99 76 [[Image(CommonImages:logo_subversion.png,nolink)]] 100 77 [[Br]]'''[http://svn.boost.org/trac/boost/wiki/BoostDocsRepository Subversion repository]''' 101 [[Br]] Our control revision control system. It is integrated to Trac allowing you to 102 browse the code [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs from the web]. 78 [[Br]] Our version control system. It is integrated to Trac allowing you to browse the code [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs from the Web]. 103 79 104 80 [[Image(CommonImages:logo_vault.png,nolink)]] 105 81 [[Br]]'''[http://tinyurl.com/2nvty4 Boost Vault]''' 106 82 [[Br]]Boost Docs and subproject releases Glue Docs Vault. 107 [[Br]]It has an integrated counter so we can track how many people isusing our work.83 [[Br]]It has an integrated counter so we can track how many people are using our work. 108 84 109 85 [[Image(CommonImages:logo_docs.png,nolink)]] 110 86 [[Br]]'''[http://beta.boost.org/development/doc/doc_test/doc/html/index.html On-line Docs]''' 111 [[Br]]We maintain an on-line version of the documentation that is already conformant 112 with the new documentation guidelines. 87 [[Br]]We maintain an online version of the documentation that already conforms to the new documentation guidelines. 113 88 114 89 [[Br]] … … 119 94 [[Br]]'''[http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs#ProjectWiki Project Wiki]''' 120 95 [[Br]]Main organization tool. 121 [[Br]]It contains formal information about subprojects and the work being done 122 by each developer. 123 [[Br]]The main purpose is to showcase our progress and avoid work duplication. 124 [[Br]]It has a structured layout to organize our workflow. New project ideas 125 are not added directly, but after a thoughtful discussion on other channels. 96 [[Br]]This contains formal information about subprojects and the work being done by each developer. 97 [[Br]]The main purposes are to showcase our progress and to avoid work duplication. 98 [[Br]]It has a structured layout to organize our workflow. New project ideas are not added directly, but rather after thoughtful discussion on other channels. 126 99 127 100 [[Image(CommonImages:logo_nabble.png,nolink)]] 128 101 [[Br]]'''[http://www.nabble.com/Boost---Doc-f14210.html Boost-docs list]''' 129 [[Br]]This is were the actual work is shared and discussed. It acts as the 130 boost-devel list for our project. 131 [[Br]]Lists are a good medium for daily work. It is a working place, all our progress 132 must pass through the boost-docs list to be viewed by every person involved 133 in the project. 102 [[Br]]This is were the actual work is shared and discussed. It acts as the boost-devel mailing list for our project. 103 [[Br]]Mailing lists are a good medium for daily work. It is a working space. All our progress must pass through the boost-docs list to be viewed by every person involved in the project. 134 104 [[Br]]You can sign in [https://lists.sourceforge.net/lists/listinfo/boost-docs here]. 135 105 … … 138 108 [[Br]]We are currently working on a formal proposal to take 139 109 advantage of Trac Ticket system for the project. 140 [[Br]]We will use it for translations tracking, subprojects control, feature requests 141 and bugs report. 110 [[Br]]We will use it for translation tracking, subproject control, feature requests and bug reporting. 142 111 143 112 [[Image(CommonImages:logo_rss.png,nolink)]] 144 113 [[Br]]'''[http://beta.boost.org/development/ibd_news.rss RSS news feed]''' 145 [[Br]]The IBD news feed consists of formal announces about the things going on in 146 the project, they are very short and direct headlines. 114 [[Br]]The IBD news feed consists of formal announcements about the things going on in the project. They are very short, direct headlines. 147 115 [[Br]]Some of the common subjects are new members, new subprojects, help requests and 148 116 completed translation. … … 154 122 [[Image(CommonImages:logo_blogger.png,nolink)]] 155 123 [[Br]]'''[http://improving-boost-docs.blogspot.com Community Blog]''' 156 [[Br]]A record of the things that happens behind the scenes, our next 157 objectives and the social and philosophical aspects of IBD. 158 [[Br]]The Blog subjects are things like summaries of private conversations, 159 possible directions for the project and new ideas. 160 [[Br]]It includes ''behind the scenes'' content, it is a place where 161 you can see what is going on in the developers mind and a tool to make us a 162 tidy community by given contributors an informal forum where to express tthemselves 163 [[Br]]There is a precedent of using Blogs for philosophical discussions, 164 and it is a lot easier to people not related to the project to comment on 165 our progress there. We encourage you to participate both as a blogger or commenting 166 about our posts. 124 [[Br]]A record of the things that happen behind the scenes, our next objectives and the social and philosophical aspects of IBD. 125 [[Br]]The subjects of the blog are things like summaries of private conversations, possible directions for the project and new ideas. 126 [[Br]]It includes behind-the-scenes content. It is a place where you can see what is going on in the developer's mind and a tool to make us a tidy community by giving contributors an informal forum in which to express themselves. 127 [[Br]]There is a precedent of using blogs for philosophical discussions, and it is a lot easier for people not related to the project to comment on our progress there. We encourage you to participate both as a blogger or by commenting on our posts. 167 128 168 129 [[Image(CommonImages:logo_linkedin.png,nolink)]] … … 177 138 [[Image(CommonImages:logo_ohloh.png,nolink)]] 178 139 [[Br]]'''[http://www.ohloh.net/projects/6385 IBD at ohloh]''' 179 [[Br]]Statistics aboutour project, code and contributors.180 [[Br]]It offers a stack s and kudos system too, that can be used as communitybuilding tools.140 [[Br]]Statistics on our project, code and contributors. 141 [[Br]]It offers a stack and kudos system too, which can be used as community-building tools. 181 142 182 143 [[Image(CommonImages:logo_statcounter.png,nolink)]] 183 144 [[Br]]'''[http://my.statcounter.com/project/standard/stats.php?project_id=2713553&guest=1 Statcounter]''' 184 [[Br]]Web pages activity statistics. 185 [[Br]]Currently it is only integrated in the Community Blog. In the future we will gather 186 information from Boost main page, the Wiki pages and boost on-line documentation. 145 [[Br]]Web page activity statistics. 146 [[Br]]Currently these are integrated into the community blog only. In the future, we will gather information from the main page of Boost's website, the wiki pages and Boost's online documentation. 187 147 188 148 [[Image(CommonImages:logo_gmane.png,nolink)]] … … 196 156 [[Image(CommonImages:help_wanted.png,nolink)]] 197 157 198 There are s mall projects waiting for one or two folks to jump into them.199 200 * Boost 158 There are some small projects waiting for one or two people to take on. 159 160 * Boost-specific WikiMacros ( [http://tinyurl.com/346vdh more information], [BoostSpecificWikiMacros project wiki page] ) 201 161 * Quickbook as a [WikiProcessors WikiProcessor] for our Trac ( [http://tinyurl.com/2l9qfy more information], [QuickbookWikiProcessor project wiki page] ) 202 162 * Trac Syntax Coloring for Boostbook, Quickbook and Jamfiles. ( [http://tinyurl.com/2myjp5 more information], [BoostTracSyntaxColoring project wiki page] ) 203 163 * Google Search Box project ( [http://tinyurl.com/2mfobx more information], [GoogleSearchBoxProject project wiki page] ) 204 * Syntax 164 * Syntax-highlighting project ( [http://tinyurl.com/35g4fv more information], [SyntaxHighlightingProject project wiki page] ) 205 165 206 166 Other ways to help us 207 167 208 * Jump in as a browser tester ( More information in the [BrowserTestingChart browser testing chart] page ) 209 * Docs Translator ( More information in the [DocsTranslationsProject docs translations project] page ) 210 * Comment about our work. We need constant feedback, please scream your opinion in the 211 [https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]. 212 * Lot of documentation on this Wiki is being written by non-native English speaker. Just reading and correcting expressions and paragraph will be appreciated. 168 * Volunteer as a browser tester ( More information in the [BrowserTestingChart browser testing chart] page ) 169 * Document translator ( More information in the [DocsTranslationsProject docs translations project] page ) 170 * Comment on our work. We need constant feedback. Please offer your opinion on the [https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]. 171 * A lot of the documentation on this wiki is being written by a non-native English-speaker. Just reading and correcting typos and grammar will be appreciated. 213 172 214 173 If you are... … … 217 176 * ... an artist, you can propose graphics to make boost look fancier. 218 177 * ... a teacher, you can write tutorials for the Glue Docs project. 219 * ... a Boost user, you can provide us with real life examples for the 220 Glue Docs project. 221 * ... a Python programmer, you can help us integrating stuff into Trac. 178 * ... a Boost user, you can provide us with real-life examples for the Glue Docs project. 179 * ... a Python programmer, you can help us to integrate things into Trac. 222 180 223 181 ---- … … 234 192 * Initial version of Boost Style 235 193 * Modular CSS design. 236 * CSS 194 * CSS-based admonitions and navigation graphics. 237 195 * Quickbook source stylesheet. 238 196 * Boostbook improvements … … 241 199 * !GroupedLinks select boxes for Boost Libraries and Section quick jumping. 242 200 * Google Search box over our docs. 243 * Box -wrapperbased blurbs that allow us to include rounded corners, drop shadows, etc.244 * Alternative s syntax highlightingincluding most common IDEs.201 * Box wrapper-based blurbs that allow us to include rounded corners, drop shadows, etc. 202 * Alternative syntax-highlighting, including most common IDEs. 245 203 * Chapter logo support. 246 * Parameter s cleanup.247 * A new PDF stylesheet based on the unified look andfeel project.204 * Parameter clean-up. 205 * A new PDF stylesheet based on the unified look-and-feel project. 248 206 * Quickbook improvements 249 207 * Initial support for SVG images in HTML docs. … … 251 209 '''Installation Notes''' 252 210 253 Copy the contents of the Boost Docs zipped file into an up todate Boost package.211 Copy the contents of the Boost Docs zipped file into an up-to-date Boost package. 254 212 255 213 ---- … … 260 218 261 219 * '''[BoostDocsRepository Boost Docs repository]'''[[Br]] 262 We are working on several boost tools to support the new features and improve their usability. 263 This work is stored in boost sandbox. Go to the boost docs repository page to learn how it is organized. 264 * '''[UnifiedLookAndFeelProject Unified look & feel project]'''[[Br]] 265 Although Boost libraries are independent entities, together they build a superb and tied library. 266 If we want People to understand this we must provide an unified style for our docs and resources. This project 267 will define the guidelines for the new look and feel of Boost. 268 * '''[DocsTranslationsProject Docs Translations]'''[[Br]] 269 If we want to have an unified look and feel in boost docs, we need that all documentation be in a standard format. 270 We are translating HTML based docs to Docbook format. There are a lot of documents to translate, we need more 271 volunteers to help in the process. If you want to participate go to the 272 docs translations project page. (We now have a bunch of tools that makes painless the 273 process, please jump in!) 220 We are working on several Boost tools to support the new features and improve their usability. This work is stored in Boost's sandbox. Go to the Boost docs repository page to learn how it is organized. 221 * '''[UnifiedLookAndFeelProject Unified look-and-feel project]'''[[Br]] 222 Although Boost libraries are independent entities, together they build a superb, unified library. If we want people to understand this, we must provide an unified style for our docs and resources. This project will define the guidelines for the new look and feel of Boost. 223 * '''[DocsTranslationsProject Doc Translations]'''[[Br]] 224 If we want to have an unified look and feel in Boost docs, we need all documentation to be in a standard format. We are translating HTML-based docs to Docbook format. There are a lot of documents to translate and we need more volunteers to help in the process. If you want to participate, go to the doc translations project page. (We now have a bunch of tools that make the process painless, so please jump in!) 274 225 * '''[GlueDocsProject Glue Docs]'''[[Br]] 275 Boost libraries documentation are an impressive tool to learn about how individual libraries work. 276 However we are missing integration documentation, that sees boost as a whole. 277 How do we do common task, which libraries are powerful when combined, real life examples; are important 278 documentation we can not expect boost authors to provide. 279 The Glue Docs project objective is to build the necessary meta-library documentation for Boost. 226 Documentation for Boost libraries is an impressive tool for learning about how individual libraries work. However, we are missing integration documentation that sees Boost as a whole. How we do common tasks, which libraries are powerful when combined, and real-life examples are important documentation that we cannot expect Boost authors to provide. The objective of the Glue Docs project is to build the necessary meta-library documentation for Boost. 280 227 * '''[StandardCppLibraryDocumentation Standard C++ Library Docs]'''[[Br]] 281 228 Provide a publicly available, vendor-neutral reference manual for the Standard C++ library, … … 284 231 Formal documents about C++ documentation best practices. 285 232 * '''[DocumentationTools Documentation Tools]'''[[Br]] 286 Projects to improve the docs tool chain, simplifying and integrating it lowering the barrier 287 for people willing to help us. 233 Projects to improve the docs tool chain, simplifying and integrating it and lowering the barrier for people willing to help us. 288 234 * '''[ImprovingBoostDocsSubprojects Subprojects]'''[[Br]] 289 There are some small subprojects targeted to solv e specific needs.235 There are some small subprojects targeted to solving specific needs. Go to the subprojects page to participate in them. 290 236 Go to the subprojects page to participate in them. 291 * '''[BrowserTestingChart Browser 292 Volunteers are periodically testing the new docs in each platform andbrowser.237 * '''[BrowserTestingChart Browser-testing]'''[[Br]] 238 Volunteers periodically test the new docs on every platform and for every browser. 293 239 * '''[LibrariesLogos Libraries Logos]'''[[Br]] 294 240 Go to the logo playground page to find proposed logos for Boost libraries. … … 298 244 == People == 299 245 300 The people list here is working on this project of has done work on the tools in wich this work builds up. Some of them may not endorse all the proposal of the project, but all have gave their blessing to it. If you are working for this project and do not appear here, please add yourself to the list. If you are listed and want to share your mailand picture here, please add them.246 The people listed below are working on this project or have done work on the tools that this work builds. Some of them may not endorse all the proposals of the project, but all have given their blessing to it. If you are working for this project and do not appear here, please add yourself to the list. If you are listed and want to share your email address and picture here, please add them. 301 247 302 248 [[Br]][[Image(People:no_picture.png,nolink)]] … … 313 259 [[Br]]'''Darren Garvey''' 314 260 [[Br]][http://www.ohloh.net/projects/3/contributors/37269 Ohloh Statistics] 315 [[Br]]'' unknown mail''261 [[Br]]''email unknown'' 316 262 [[Br]] 317 263 [[Br]][[Image(People:dave_abrahams.png,nolink)]] … … 324 270 [[Br]]'''Douglas Gregor''' 325 271 [[Br]][http://www.ohloh.net/projects/3/contributors/101 Ohloh Statistics] 326 [[Br]]'' unknown mail''272 [[Br]]''email unknown'' 327 273 [[Br]] 328 274 [[Br]][[Image(People:eric_niebler.png,nolink)]] … … 330 276 [[Br]][http://www.ohloh.net/projects/3/contributors/100 Ohloh Statistics] 331 277 [[Br]][http://www.linkedin.com/pub/0/87/642 Linked In Profile] 332 [[Br]]'' unknown mail''278 [[Br]]''email unknown'' 333 279 [[Br]] 334 280 [[Br]][[Image(People:no_picture.png,nolink)]] 335 281 [[Br]]'''Filip Konvička''' 336 [[Br]]'' unknown mail''282 [[Br]]''email unknown'' 337 283 [[Br]] 338 284 [[Br]][[Image(People:glyn_matthews.png,nolink)]] … … 350 296 [[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh Statistics] 351 297 [[Br]][http://www.linkedin.com/pub/0/89/716 Linked In Profile] 352 [[Br]]'' unknown mail''298 [[Br]]''email unknown'' 353 299 [[Br]] 354 300 [[Br]][[Image(People:john_maddock.png,nolink)]] 355 301 [[Br]]'''John Maddock''' 356 302 [[Br]][http://www.ohloh.net/projects/3/contributors/86 Ohloh Statistics] 357 [[Br]]'' unknown mail''303 [[Br]]''email unknown'' 358 304 [[Br]] 359 305 [[Br]][[Image(People:matias_capeletto.png,nolink)]] … … 365 311 [[Br]][[Image(People:no_picture.png,nolink)]] 366 312 [[Br]]'''Paul Bristow''' 367 [[Br]]'' unknown mail''313 [[Br]]''email unknown'' 368 314 [[Br]] 369 315 [[Br]][[Image(People:no_picture.png,nolink)]] … … 375 321 [[Br]][http://www.ohloh.net/accounts/911/positions/1130 Ohloh Statistics] 376 322 [[Br]][http://www.linkedin.com/in/rrivera Linked In Profile] 377 [[Br]]'' unknown mail''323 [[Br]]''email unknown'' 378 324 [[Br]] 379 325 [[Br]][[Image(People:stjepan_rajko.png,nolink)]] … … 394 340 [[Br]]''Team Mascot'' 395 341 396 She is a [http://en.wikipedia.org/wiki/English_Springer_Spaniel English Springer Spaniel] 397 from Argentina, currently living with Matias. 398 Mafalda is helping him with the project Wiki page. She just barks once in a while, but that is a lot. 342 Mafalda is an [http://en.wikipedia.org/wiki/English_Springer_Spaniel English springer spaniel] from Argentina, currently living with Matias. She is helping him with the project wiki page. She just barks once in a while, but that is a lot. 399 343 400 344 ---- … … 404 348 [[Image(http://matias.capeletto.googlepages.com/thanks.png,nolink)]] 405 349 406 Big thanks to Daniel James, Janek Kozicki, João Abecasis, Matt Doyle, Michael Marcin. You are welcome to became active members of the project, in that case please add yourself to the list above. 407 Thanks to all the others that have help us with discussion on the boost list. 350 Big thanks to Daniel James, Janek Kozicki, João Abecasis, Matt Doyle and Michael Marcin. You are welcome to became active members of the project, in which case please add yourselves to the list above. Thanks to all the others who have helped us in discussion on the Boost list. 408 351 409 352 ---- … … 412 355 * '''[ImprovingBoostDocs About this project]''' 413 356 * [BoostDocsRepository Boost docs repository] 414 * [UnifiedLookAndFeelProject Unified look &feel project]357 * [UnifiedLookAndFeelProject Unified look-and-feel project] 415 358 * [DocsTranslationsProject Docs translations project] 416 359 * [GlueDocsProject Glue docs project]