Tasks #900
Finalize initial version of RSB manual
| Status: | Resolved | Start date: | 07/13/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | J. Moringen | % Done: | 100% | |
| Category: | Documentation | |||
| Target version: | rsb-0.7 |
Description
We have discussed the following changes regarding the structure:
Thus, creterion for closing this issue:
- Finer grained table of contents ✓
- Depth should be two levels ✓
- Glossary should be included ✓
- More compact examples in man-page-like documentation ✓
- Use-cases instead of tutorial ✓
- Longer examples from man-pages should be moved to this section ✓
- Examples should be easily reproducible and not require complicated setups (e.g. a Nao robot) whenever possible
- Project version should be part of deployment URL ✓
Thus, creterion for closing this issue:
- The C++ parts of manual have to be tested (e.g. installation from scratch)
- The Python parts of manual have to be tested (e.g. installation from scratch) ✓
- By a naive user (Simon Drexel) ✓
Subtasks
Related issues
Associated revisions
Trouble Shooting -> Troubleshooting
refs #900
refs #900
- manual/index.rst: fixed reference manual/trouble-shooting.rst ->
manual/troubleshooting.rst - manual/troubleshooting.rst: renamed manual/trouble-shooting.rst ->
manual/troubleshooting.rst; fixed title Trouble Shooting ->
Troubleshooting
Added file manual/glossary.rst
refs #900
refs #900
- manual/glossary.rst: new file; glossary for rsbag terminology
- manual/index.rst: reference manual/glossary.rst
- manual/bag-cat.rst: turned occurrences of "log file" into glossary
references - manual/bag-info.rst: likewise
- manual/bag-merge.rst: likewise
- manual/bag-play.rst: likewise
- manual/bag-record.rst: likewise
- manual/tools.rst: likewise
Changed table of contents structure in manual/index.rst
refs #900
refs #900
- manual/index.rst: changed depth of table of contents to two levels
- manual/tutorial.rst: added link target
Moved examples from man-pages to manual/use-cases.rst
refs #900
refs #900
- manual/bag-cat.rst: shortened examples; moved full examples to
manual/use-cases.rst - manual/bag-info.rst: likewise
- manual/bag-merge.rst: likewise
- manual/bag-play.rst: likewise
- manual/bag-record.rst: likewise
- manual/index.rst: likewise
- manual/use-cases.rst: renamed manual/tutorial.rst ->
manual/use-cases.rst; added examples formerly contained in man-pages
Added "Remote Control" section in manual/bag-record.rst
refs #900
refs #900
- manual/bag-record.rst: added section "Remote Control"
Added links to use-case sections in manual/index.rst
refs #900
refs #900
- manual/index.rst: added links to use-case sections
- manual/use-cases.rst: added link targets to level 2 sections
Improved Java installation instructions
fixes #900
fixes #900
- conf.py.in: added links for spread tarbar, ant tool and javadoc tool
- install-java.rst: fixed some links, replacement and general markup
issues; simplified some sections - preparation.rst: similar; adapted Spread Python tarball link
History
#1 Updated by J. Moringen over 12 years ago
- Description updated (diff)
- Status changed from New to In Progress
- Assignee set to J. Moringen
- Target version set to 0.6
#2 Updated by J. Moringen over 12 years ago
- Tracker changed from Bug to Tasks
#3 Updated by J. Moringen over 12 years ago
- Description updated (diff)
- % Done changed from 0 to 70
#4 Updated by J. Moringen over 12 years ago
- Description updated (diff)
- Target version changed from 0.6 to rsb-0.7
- % Done changed from 70 to 90
#5 Updated by J. Moringen over 12 years ago
- Status changed from In Progress to Feedback
Is the manual usuable? Could the structure be improved? What is missing?
#6 Updated by J. Moringen about 12 years ago
- Description updated (diff)
#7 Updated by J. Moringen about 12 years ago
- Project changed from RSBag to Robotics Service Bus
#8 Updated by J. Moringen about 12 years ago
- Category set to Documentation
#9 Updated by J. Moringen about 12 years ago
- Description updated (diff)
#10 Updated by J. Moringen about 12 years ago
- Description updated (diff)
#11 Updated by J. Moringen about 12 years ago
- Description updated (diff)
#12 Updated by J. Moringen about 12 years ago
- Subject changed from Evaluate current manual structure and correctnes to Finalize initial version of RSB manual
#13 Updated by J. Moringen almost 12 years ago
- Status changed from Feedback to Resolved
- % Done changed from 80 to 100
Applied in changeset r3767.
#14 Updated by J. Moringen almost 12 years ago
- Status changed from Resolved to In Progress
Incorrectly fixed by r3767.
#15 Updated by Anonymous almost 12 years ago
- Status changed from In Progress to Resolved
Applied in changeset rsb-manual|commit:db2f6d3acf4ece4f2ab45e4bdc8e9536fcd538b6.
#16 Updated by J. Wienke almost 12 years ago
- Status changed from Resolved to In Progress
Revert incorrect fix again after git push
#17 Updated by J. Moringen almost 12 years ago
- Description updated (diff)
- Status changed from In Progress to Resolved