Opened 14 years ago
Closed 13 years ago
#1590 closed task (fixed)
Documentation cleanup
Reported by: | Nicklas Nordborg | Owned by: | everyone |
---|---|---|---|
Priority: | major | Milestone: | BASE 3.0 |
Component: | documentation | Version: | |
Keywords: | Cc: |
Description
We should go through the documentation and at least fix things that are incorrect. Some parts may be missing information due to functionality that has been added. It would be good if we could fill in missing parts of incomplete sections. Then, there are several sections that hasn't been written yet, but that is not part of this ticket.
Change History (46)
comment:1 by , 14 years ago
comment:2 by , 14 years ago
(In [5640]) References #1590: Documentation cleanup
Checked and changed the following chapters in Part IV: Developer documentation:
- Plug-in developer sections 7-9. (section 6 is not yet done since there are tickets that will affect lots of information in this section)
- Extensions developer + added a new section with more information about extension points shipped with BASE.
comment:3 by , 13 years ago
(In [5654]) References #1590: Documentation cleanup
Checked and changed the following chapters in Part IV: Developer documentation:
- Plug-in developer sections 6. Removed documentation about file validators since that is now an extensions.
- Extensions developer section 8. Added documentation about file set validators.
Made a modification in the docbook templates so that the full package+class name is shown in the link leading to the javadoc.
comment:4 by , 13 years ago
comment:5 by , 13 years ago
comment:6 by , 13 years ago
comment:7 by , 13 years ago
(In [5676]) References #1590: Documentation cleanup
- Fixed link to syntax highlighter
- Changed color of left border used on code examples and <hr> tags
- Changed date format to "yyyy-MM-dd" for last modified footer
- Added last modified information to title page
- Decreased vertical white space around some headers
- Added more links/title information to navigation header and footer
comment:8 by , 13 years ago
(In [5677]) References #1590: Documentation cleanup
- Removed migration-related information from the appendix
- Removed "Appendix: Menu guide".
- Removed BASE 2.x-related information from the appendix (API changes that may affect backwards compatibility and Things to consider when updating an existing BASE installation).
comment:9 by , 13 years ago
comment:10 by , 13 years ago
comment:11 by , 13 years ago
comment:12 by , 13 years ago
comment:13 by , 13 years ago
comment:14 by , 13 years ago
comment:15 by , 13 years ago
(In [5706]) References #1590: Documentation cleanup
User documentation chapter 10 to 15. Added new chapter about "Item subtypes". Removed sections about protocol types, hardware types and software types. Merged "Hardware" and "Software" into a single chapter.
Added some menu separators in the New annotation type menu.
As usual, screen shots have not yet been updated.
comment:16 by , 13 years ago
(In [5708]) References #1590: Documentation cleanup
Biomaterials section. Added empty sections for biomaterial lists and bioplate events that hopefully will be written some day. All screen shots must be updated.
Fixed spelling of "bioplate" in a lot of jsp scripts.
Display well coordinates without brackets. A1
instead of [A,1]
.
Fixed an issue with the regular expression used to link different help texts in the web client.
Reorganized the biomaterial lims menu so that it is consistent with the documentation.
comment:17 by , 13 years ago
comment:18 by , 13 years ago
comment:20 by , 13 years ago
(In [5737]) References #1590: Documentation cleanup
Updated Admin documentation:
- Installation and updgrade instructions
- Plug-ins and extensions
A lot of information has been moved around/merged with other parts. Screen shots are the old ones, which can be a bit confusing since the differences are big.
comment:21 by , 13 years ago
comment:22 by , 13 years ago
comment:23 by , 13 years ago
comment:24 by , 13 years ago
comment:25 by , 13 years ago
comment:26 by , 13 years ago
comment:27 by , 13 years ago
comment:28 by , 13 years ago
comment:29 by , 13 years ago
comment:30 by , 13 years ago
comment:31 by , 13 years ago
comment:32 by , 13 years ago
comment:33 by , 13 years ago
comment:34 by , 13 years ago
comment:35 by , 13 years ago
(In [5799]) References #1590: Documentation cleanup
- Homepage screenshot was missing top and left line of pixels.
- Made a smalled "Select import plug-in" screen shot.
- Fixed incorrect help text ids in "Edit extract" dialog.
- Help text dialog follows window resizing.
- Zoom edit dialog follows window resizing.
- Notes, warnings, etc. in help text use rounded corners.
comment:36 by , 13 years ago
comment:37 by , 13 years ago
comment:38 by , 13 years ago
comment:39 by , 13 years ago
comment:40 by , 13 years ago
(In [5818]) References #1590: Documentation cleanup
Some more sections in the developer documentation should now be up-to-date:
- Web services
- Parts of "The BASE API"
- section 1: The public api of BASE.
- section 2: The data layer api
- section 3.9: Using files to store data
- section 3.10: Sending signals to plug-ins
Sections 3.1 -- 3.8 are in the old format and will not be updated now.
"The Query API" and "The Dynamic API" are in the old format and will not be updated now.
"The Extensions API" need a big re-write.
Also fixed a lot of javadoc links leading to the developer documentation.
comment:41 by , 13 years ago
comment:42 by , 13 years ago
comment:43 by , 13 years ago
comment:44 by , 13 years ago
comment:45 by , 13 years ago
comment:46 by , 13 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
(In [5633]) References #1590: Documentation cleanup
Checked and changed the following chapters in Part IV: Developer documentation: